[PATCH] Rewrite faq page to look like a mock man-page. Changes capitalization to regular case to follow theming better and to improve legibility.
From: Lunarmagpie <Bambolambo0@gmail.com> --- data/templates/index.html | 11 ++-- pages/faq.md | 111 ++++++++++++++++++++------------------ 2 files changed, 63 insertions(+), 59 deletions(-) diff --git a/data/templates/index.html b/data/templates/index.html index 79b522e..419d3c4 100644 --- a/data/templates/index.html +++ b/data/templates/index.html @@ -7,12 +7,11 @@ <title>shring sh webring</title> </head> <body> - <h1>shring sh webring</h1> <p> - <code>$ man shring</code><br> + <code>$ shring about</code><br> <strong>shring</strong> (pronounced "shring", semantically "sh ring")<br> is <strong>a small web of unix-y personal sites</strong>.<br> - <strong>there are no further qualifiers</strong>. see the <a href="/faq">faq</a> for + <strong>there are no further qualifiers</strong>. please run <a href="/faq">`man shring`</a> for details.<br><br> <code>$ shring stat && shring ls --html | render</code><br> <strong><code>{{ number_of_sites }} members, built {{ current_time }} @@ -23,14 +22,14 @@ <code>$ shring feed --opml ><a href="{{ opml }}" >./shring.opml</a></code><br> <br> - <code>$ man 7 shring</code><br> + <code>$ shring tooling</code><br> shring is powered by <a href="https://github.com/k3rs3d/ringfairy" >ringfairy</a>, maintained by <a href="https://ficd.sh">daniel</a>, <a href="https://git.ficd.sh/ficd/shring" target="_blank" >open source</a>, and proudly <a href="https://no-js.club/">no-js</a>. - for information about joining, please see the <a href="/faq" - >faq</a>.<br><br> + for information about joining, please run <a href="/faq" + >`man shring`</a>.<br><br> </p> </body> </html> diff --git a/pages/faq.md b/pages/faq.md index 4373ad9..8b229ff 100644 --- a/pages/faq.md +++ b/pages/faq.md @@ -1,11 +1,7 @@ -<h1>shring faq</h1> - <center> <a href="/">return to index</a> </center> -<h3 id="toc">contents</h3> - <style> html { scroll-behavior: smooth; @@ -22,58 +18,65 @@ a { </style> +$ man shring + +<h3 id="toc">CONTENTS</h3> + <!--toc:start--> -- [what is the shring?](#what-is-the-shring) -- [what is a unix-y personal site?](#what-is-a-unix-y-personal-site) -- [what are the requirements to join?](#what-are-the-requirements-to-join) -- [do i need to use unix?](#do-i-need-to-use-unix) -- [can my site have javascript?](#can-my-site-have-javascript) -- [how can i join?](#how-can-i-join) -- [how is shring built?](#how-is-shring-built) +- [DESCRIPTION](#description) +- [EXAMPLES](#examples) +- [DEPENDENCIES](#dependencies) +- [CAN I USE JAVASCRIPT](#can-i-use-javascript) +- [HOW CAN I JOIN](#how-can-i-join) <!--toc:end--> -## what is the shring? +<h3 id="description">DESCRIPTION</h3> -the shring (pronounced "shring") +The shring (pronounced "shring") is **a small web of unix-y personal sites.** the word is composed of "sh" for "shell" and "ring" for "ring". -more specifically, +More specifically, shring is a **webring**. each site links to its "next" and "previous" neighbor. -if you follow the links, +If you follow the links, you'll eventually return to the page you started on. -**every shring member site is** +**Every shring member site is** 1. **personal** -2. **unix-y** +2. **unix-y**. -**there are no further qualifiers.** +**There are no further qualifiers.** -if a site meets these requirements, it's shringworthy. +If a site meets these requirements, it's shringworthy. [return](#toc) -## what is a unix-y personal site? +<h3 id="examples">EXAMPLES</h3> -we don't attempt to formalize a definition. -we all have some amorphous and generally interoperable idea +$ shring definition + +We don't attempt to formalize a definition. +We all have some amorphous and generally interoperable idea of what "**unix-y**" actually means. -in a sense, our understanding +In a sense, our understanding of what it means to be "unix-y" **is in itself unix-y**. -**we don't define unix-y +**We don't define unix-y because that would be un-unix-y.** -instead, we offer two **contrasting, non-authoritative examples**. +Instead, we offer two **contrasting, non-authoritative examples**. + -**a unix-y personal site is not**\ -an seo sloptimized "website" +$ shring counterexample + +**A unix-y personal site is not:**\ +An seo sloptimized "website" that only functions as a portfolio for landing an entry level developer job where every post is about @@ -81,8 +84,10 @@ the latest frontend agentic javascript ml tokenizer agent and what it taught you about b2b sales. -**a unix-y personal site can be**\ -blogs about your experience learning new programming paradigms, +$ shring example + +**A unix-y personal site can be:**\ +Blogs about your experience learning new programming paradigms, accounts of tinkering with shell scripts, stream-of-consciousness rambles about text editors, essays on the impermanence of being, @@ -95,23 +100,23 @@ kernel de(output truncated) [return](#toc) -## what are the requirements to join? +<h3 id="dependencies">DEPENDENCIES</h3> -your website: +Your website: -- must be a "**unix-y personal site**" as per the descriptions above -- must display shring's webring links +- Must be a "**unix-y personal site**" as per the descriptions above. +- Must display shring's webring links. - **heuristic**: you shouldn't have to go looking into the html source or some other voodoo shit just to find the next site in the webring -- must **not** be corpo slopware -- must **not** contain bigotry or hatred +- Must **not** be corpo slopware. +- Must **not** contain bigotry or hatred. [return](#toc) -## do i need to use unix? +<h3 id="do-i-need-to-use-unix">DO I NEED TO USE UNIX</h3> -the "-y" in "unix**-y**" is important. -if you (and by extension, your personal site) +The "-y" in "unix**-y**" is important. +If you (and by extension, your personal site) appreciate free software, the unix philosophy, hacking, and tinkering, then the shring welcomes you, @@ -119,24 +124,24 @@ os choice notwithstandding. [return](#toc) -## can my site have javascript? +<h3 id="can-i-use-javascript">CAN I USE JAVASCRIPT</h3> -although shring is proudly [no-js](https://no-js.club/), +Although shring is proudly [no-js](https://no-js.club/), and you certainly get bonus points for a static, javascript-free website,\ **member sites are welcome to include javascript**. -**however**, -if your site makes use of **bloated frameworks**, +**However**, +If your site makes use of **bloated frameworks**, **runs poorly** on older hardware, **serves ads**, or **tracks** its visitors, **it does not belong in the shring**. [return](#toc) -## how can i join? +<h3 id="how-can-i-join">HOW CAN I JOIN</h3> -to apply, compile the following information: +To apply, compile the following information: - the **name** of your site - your **url** @@ -149,25 +154,25 @@ to apply, compile the following information: - your **name**: - this can be a full name, nickname, username, whatever you want -please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh). +Please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh). -you will receive a response via [carrier pigeon](https://nameecho.com/carrior) +You will receive a response via [carrier pigeon](https://nameecho.com/carrior) within 300 business years. if you prefer to be contacted by message-in-a-bottle, include the name of the nearest body of water with an accessible shoreline, and your request will be accommodated. -preferably before applying, +Preferably before applying, add your shring links to your website: - `shring.sh/your-slug/previous` - `shring.sh` - `shring.sh/your-slug/next` -you are responsible for styling and positioning them +You are responsible for styling and positioning them however you see fit. -optional `88x31px` banners are coming soon. +Optional `88x31px` banners are coming soon. we also have a [mailing list](https://lists.jdugan6240.dev/mailman3/lists/shring.lists.jdugan6240.dev), which is used for announcements, @@ -179,13 +184,13 @@ The mailing list is maintained by [jdugan6240](https://jdugan6240.dev). [return](#toc) -## how is shring built? +<h3 id="architecture">ARCHITECTURE</h3> -shring's source is available on [git.ficd.sh](https://git.ficd.sh/ficd/shring). -the webring "backend" (static pages with html redirects) +The source code for shring is available's [git.ficd.sh](https://git.ficd.sh/ficd/shring). +Rhe webring "backend" (static pages with html redirects) is built using [ringfairy](https://github.com/k3rs3d/ringfairy). -additional pages (including this one) +Additional pages (including this one) are generated by a shell script. they are written in markdown, converted to html with pandoc, -- 2.50.1
Thanks for the patch! At a quick glance on mobile, it looks pretty good. I'll take a closer look at it tomorrow. One question: is there a reason why you've changed the Markdown headings to raw HTML with IDs? If it's just to make them work with the TOC, pandoc already handles that during conversation, converting the heading's content to kebab-case and setting it as the ID. Since I've been using Marksman to generate the TOC from the headings, I'd prefer to keep them as Markdown. If there's a particular reason you made the change, please let me know. Otherwise, I'll take them out of the patch so it's a bit easier to maintain the FAQ as a Markdown document. Cheers, Daniel P.S. Doing the patches over the mailing list is a great idea. Fits the unix-y ethos very well, and it keeps the development history archived for future members. Let's keep this up! On Sat, Jul 26, 2025, at 23:04, Zunda wrote:
From: Lunarmagpie <Bambolambo0@gmail.com>
--- data/templates/index.html | 11 ++-- pages/faq.md | 111 ++++++++++++++++++++------------------ 2 files changed, 63 insertions(+), 59 deletions(-)
diff --git a/data/templates/index.html b/data/templates/index.html index 79b522e..419d3c4 100644 --- a/data/templates/index.html +++ b/data/templates/index.html @@ -7,12 +7,11 @@ <title>shring sh webring</title> </head> <body> - <h1>shring sh webring</h1> <p> - <code>$ man shring</code><br> + <code>$ shring about</code><br> <strong>shring</strong> (pronounced "shring", semantically "sh ring")<br> is <strong>a small web of unix-y personal sites</strong>.<br> - <strong>there are no further qualifiers</strong>. see the <a href="/faq">faq</a> for + <strong>there are no further qualifiers</strong>. please run <a href="/faq">`man shring`</a> for details.<br><br> <code>$ shring stat && shring ls --html | render</code><br> <strong><code>{{ number_of_sites }} members, built {{ current_time }} @@ -23,14 +22,14 @@ <code>$ shring feed --opml ><a href="{{ opml }}" >./shring.opml</a></code><br> <br> - <code>$ man 7 shring</code><br> + <code>$ shring tooling</code><br> shring is powered by <a href="https://github.com/k3rs3d/ringfairy" >ringfairy</a>, maintained by <a href="https://ficd.sh">daniel</a>, <a href="https://git.ficd.sh/ficd/shring" target="_blank" >open source</a>, and proudly <a href="https://no-js.club/">no-js</a>. - for information about joining, please see the <a href="/faq" - >faq</a>.<br><br> + for information about joining, please run <a href="/faq" + >`man shring`</a>.<br><br> </p> </body> </html> diff --git a/pages/faq.md b/pages/faq.md index 4373ad9..8b229ff 100644 --- a/pages/faq.md +++ b/pages/faq.md @@ -1,11 +1,7 @@ -<h1>shring faq</h1> - <center> <a href="/">return to index</a> </center>
-<h3 id="toc">contents</h3> - <style> html { scroll-behavior: smooth; @@ -22,58 +18,65 @@ a {
</style>
+$ man shring + +<h3 id="toc">CONTENTS</h3> + <!--toc:start-->
-- [what is the shring?](#what-is-the-shring) -- [what is a unix-y personal site?](#what-is-a-unix-y-personal-site) -- [what are the requirements to join?](#what-are-the-requirements-to-join) -- [do i need to use unix?](#do-i-need-to-use-unix) -- [can my site have javascript?](#can-my-site-have-javascript) -- [how can i join?](#how-can-i-join) -- [how is shring built?](#how-is-shring-built) +- [DESCRIPTION](#description) +- [EXAMPLES](#examples) +- [DEPENDENCIES](#dependencies) +- [CAN I USE JAVASCRIPT](#can-i-use-javascript) +- [HOW CAN I JOIN](#how-can-i-join)
<!--toc:end-->
-## what is the shring? +<h3 id="description">DESCRIPTION</h3>
-the shring (pronounced "shring") +The shring (pronounced "shring") is **a small web of unix-y personal sites.** the word is composed of "sh" for "shell" and "ring" for "ring".
-more specifically, +More specifically, shring is a **webring**. each site links to its "next" and "previous" neighbor. -if you follow the links, +If you follow the links, you'll eventually return to the page you started on.
-**every shring member site is** +**Every shring member site is**
1. **personal** -2. **unix-y** +2. **unix-y**.
-**there are no further qualifiers.** +**There are no further qualifiers.**
-if a site meets these requirements, it's shringworthy. +If a site meets these requirements, it's shringworthy.
[return](#toc)
-## what is a unix-y personal site? +<h3 id="examples">EXAMPLES</h3>
-we don't attempt to formalize a definition. -we all have some amorphous and generally interoperable idea +$ shring definition + +We don't attempt to formalize a definition. +We all have some amorphous and generally interoperable idea of what "**unix-y**" actually means. -in a sense, our understanding +In a sense, our understanding of what it means to be "unix-y" **is in itself unix-y**.
-**we don't define unix-y +**We don't define unix-y because that would be un-unix-y.**
-instead, we offer two **contrasting, non-authoritative examples**. +Instead, we offer two **contrasting, non-authoritative examples**. +
-**a unix-y personal site is not**\ -an seo sloptimized "website" +$ shring counterexample + +**A unix-y personal site is not:**\ +An seo sloptimized "website" that only functions as a portfolio for landing an entry level developer job where every post is about @@ -81,8 +84,10 @@ the latest frontend agentic javascript ml tokenizer agent and what it taught you about b2b sales.
-**a unix-y personal site can be**\ -blogs about your experience learning new programming paradigms, +$ shring example + +**A unix-y personal site can be:**\ +Blogs about your experience learning new programming paradigms, accounts of tinkering with shell scripts, stream-of-consciousness rambles about text editors, essays on the impermanence of being, @@ -95,23 +100,23 @@ kernel de(output truncated)
[return](#toc)
-## what are the requirements to join? +<h3 id="dependencies">DEPENDENCIES</h3>
-your website: +Your website:
-- must be a "**unix-y personal site**" as per the descriptions above -- must display shring's webring links +- Must be a "**unix-y personal site**" as per the descriptions above. +- Must display shring's webring links. - **heuristic**: you shouldn't have to go looking into the html source or some other voodoo shit just to find the next site in the webring -- must **not** be corpo slopware -- must **not** contain bigotry or hatred +- Must **not** be corpo slopware. +- Must **not** contain bigotry or hatred.
[return](#toc)
-## do i need to use unix? +<h3 id="do-i-need-to-use-unix">DO I NEED TO USE UNIX</h3>
-the "-y" in "unix**-y**" is important. -if you (and by extension, your personal site) +The "-y" in "unix**-y**" is important. +If you (and by extension, your personal site) appreciate free software, the unix philosophy, hacking, and tinkering, then the shring welcomes you, @@ -119,24 +124,24 @@ os choice notwithstandding.
[return](#toc)
-## can my site have javascript? +<h3 id="can-i-use-javascript">CAN I USE JAVASCRIPT</h3>
-although shring is proudly [no-js](https://no-js.club/), +Although shring is proudly [no-js](https://no-js.club/), and you certainly get bonus points for a static, javascript-free website,\ **member sites are welcome to include javascript**.
-**however**, -if your site makes use of **bloated frameworks**, +**However**, +If your site makes use of **bloated frameworks**, **runs poorly** on older hardware, **serves ads**, or **tracks** its visitors, **it does not belong in the shring**.
[return](#toc)
-## how can i join? +<h3 id="how-can-i-join">HOW CAN I JOIN</h3>
-to apply, compile the following information: +To apply, compile the following information:
- the **name** of your site - your **url** @@ -149,25 +154,25 @@ to apply, compile the following information: - your **name**: - this can be a full name, nickname, username, whatever you want
-please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh). +Please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh).
-you will receive a response via [carrier pigeon](https://nameecho.com/carrior) +You will receive a response via [carrier pigeon](https://nameecho.com/carrior) within 300 business years. if you prefer to be contacted by message-in-a-bottle, include the name of the nearest body of water with an accessible shoreline, and your request will be accommodated.
-preferably before applying, +Preferably before applying, add your shring links to your website:
- `shring.sh/your-slug/previous` - `shring.sh` - `shring.sh/your-slug/next`
-you are responsible for styling and positioning them +You are responsible for styling and positioning them however you see fit. -optional `88x31px` banners are coming soon. +Optional `88x31px` banners are coming soon.
we also have a [mailing list](https://lists.jdugan6240.dev/mailman3/lists/shring.lists.jdugan6240.dev), which is used for announcements, @@ -179,13 +184,13 @@ The mailing list is maintained by [jdugan6240](https://jdugan6240.dev).
[return](#toc)
-## how is shring built? +<h3 id="architecture">ARCHITECTURE</h3>
-shring's source is available on [git.ficd.sh](https://git.ficd.sh/ficd/shring). -the webring "backend" (static pages with html redirects) +The source code for shring is available's [git.ficd.sh](https://git.ficd.sh/ficd/shring). +Rhe webring "backend" (static pages with html redirects) is built using [ringfairy](https://github.com/k3rs3d/ringfairy).
-additional pages (including this one) +Additional pages (including this one) are generated by a shell script. they are written in markdown, converted to html with pandoc, -- 2.50.1
_______________________________________________ Shring mailing list -- shring@lists.jdugan6240.dev To unsubscribe send an email to shring-leave@lists.jdugan6240.dev
The reason I changed them was purely stylistic. This was the first way I thought of to make bold text that you can jump to by clicking on a link. I think we can use h4 instead. I just realized it looks exactly the same as what I did and will integrate with pandoc better. On July 27, 2025 2:31:24 AM EDT, Daniel Fichtinger <daniel@ficd.sh> wrote:
Thanks for the patch! At a quick glance on mobile, it looks pretty good. I'll take a closer look at it tomorrow.
One question: is there a reason why you've changed the Markdown headings to raw HTML with IDs? If it's just to make them work with the TOC, pandoc already handles that during conversation, converting the heading's content to kebab-case and setting it as the ID. Since I've been using Marksman to generate the TOC from the headings, I'd prefer to keep them as Markdown.
If there's a particular reason you made the change, please let me know. Otherwise, I'll take them out of the patch so it's a bit easier to maintain the FAQ as a Markdown document.
Cheers, Daniel
P.S. Doing the patches over the mailing list is a great idea. Fits the unix-y ethos very well, and it keeps the development history archived for future members. Let's keep this up!
On Sat, Jul 26, 2025, at 23:04, Zunda wrote:
From: Lunarmagpie <Bambolambo0@gmail.com>
--- data/templates/index.html | 11 ++-- pages/faq.md | 111 ++++++++++++++++++++------------------ 2 files changed, 63 insertions(+), 59 deletions(-)
diff --git a/data/templates/index.html b/data/templates/index.html index 79b522e..419d3c4 100644 --- a/data/templates/index.html +++ b/data/templates/index.html @@ -7,12 +7,11 @@ <title>shring sh webring</title> </head> <body> - <h1>shring sh webring</h1> <p> - <code>$ man shring</code><br> + <code>$ shring about</code><br> <strong>shring</strong> (pronounced "shring", semantically "sh ring")<br> is <strong>a small web of unix-y personal sites</strong>.<br> - <strong>there are no further qualifiers</strong>. see the <a href="/faq">faq</a> for + <strong>there are no further qualifiers</strong>. please run <a href="/faq">`man shring`</a> for details.<br><br> <code>$ shring stat && shring ls --html | render</code><br> <strong><code>{{ number_of_sites }} members, built {{ current_time }} @@ -23,14 +22,14 @@ <code>$ shring feed --opml ><a href="{{ opml }}" >./shring.opml</a></code><br> <br> - <code>$ man 7 shring</code><br> + <code>$ shring tooling</code><br> shring is powered by <a href="https://github.com/k3rs3d/ringfairy" >ringfairy</a>, maintained by <a href="https://ficd.sh">daniel</a>, <a href="https://git.ficd.sh/ficd/shring" target="_blank" >open source</a>, and proudly <a href="https://no-js.club/">no-js</a>. - for information about joining, please see the <a href="/faq" - >faq</a>.<br><br> + for information about joining, please run <a href="/faq" + >`man shring`</a>.<br><br> </p> </body> </html> diff --git a/pages/faq.md b/pages/faq.md index 4373ad9..8b229ff 100644 --- a/pages/faq.md +++ b/pages/faq.md @@ -1,11 +1,7 @@ -<h1>shring faq</h1> - <center> <a href="/">return to index</a> </center>
-<h3 id="toc">contents</h3> - <style> html { scroll-behavior: smooth; @@ -22,58 +18,65 @@ a {
</style>
+$ man shring + +<h3 id="toc">CONTENTS</h3> + <!--toc:start-->
-- [what is the shring?](#what-is-the-shring) -- [what is a unix-y personal site?](#what-is-a-unix-y-personal-site) -- [what are the requirements to join?](#what-are-the-requirements-to-join) -- [do i need to use unix?](#do-i-need-to-use-unix) -- [can my site have javascript?](#can-my-site-have-javascript) -- [how can i join?](#how-can-i-join) -- [how is shring built?](#how-is-shring-built) +- [DESCRIPTION](#description) +- [EXAMPLES](#examples) +- [DEPENDENCIES](#dependencies) +- [CAN I USE JAVASCRIPT](#can-i-use-javascript) +- [HOW CAN I JOIN](#how-can-i-join)
<!--toc:end-->
-## what is the shring? +<h3 id="description">DESCRIPTION</h3>
-the shring (pronounced "shring") +The shring (pronounced "shring") is **a small web of unix-y personal sites.** the word is composed of "sh" for "shell" and "ring" for "ring".
-more specifically, +More specifically, shring is a **webring**. each site links to its "next" and "previous" neighbor. -if you follow the links, +If you follow the links, you'll eventually return to the page you started on.
-**every shring member site is** +**Every shring member site is**
1. **personal** -2. **unix-y** +2. **unix-y**.
-**there are no further qualifiers.** +**There are no further qualifiers.**
-if a site meets these requirements, it's shringworthy. +If a site meets these requirements, it's shringworthy.
[return](#toc)
-## what is a unix-y personal site? +<h3 id="examples">EXAMPLES</h3>
-we don't attempt to formalize a definition. -we all have some amorphous and generally interoperable idea +$ shring definition + +We don't attempt to formalize a definition. +We all have some amorphous and generally interoperable idea of what "**unix-y**" actually means. -in a sense, our understanding +In a sense, our understanding of what it means to be "unix-y" **is in itself unix-y**.
-**we don't define unix-y +**We don't define unix-y because that would be un-unix-y.**
-instead, we offer two **contrasting, non-authoritative examples**. +Instead, we offer two **contrasting, non-authoritative examples**. +
-**a unix-y personal site is not**\ -an seo sloptimized "website" +$ shring counterexample + +**A unix-y personal site is not:**\ +An seo sloptimized "website" that only functions as a portfolio for landing an entry level developer job where every post is about @@ -81,8 +84,10 @@ the latest frontend agentic javascript ml tokenizer agent and what it taught you about b2b sales.
-**a unix-y personal site can be**\ -blogs about your experience learning new programming paradigms, +$ shring example + +**A unix-y personal site can be:**\ +Blogs about your experience learning new programming paradigms, accounts of tinkering with shell scripts, stream-of-consciousness rambles about text editors, essays on the impermanence of being, @@ -95,23 +100,23 @@ kernel de(output truncated)
[return](#toc)
-## what are the requirements to join? +<h3 id="dependencies">DEPENDENCIES</h3>
-your website: +Your website:
-- must be a "**unix-y personal site**" as per the descriptions above -- must display shring's webring links +- Must be a "**unix-y personal site**" as per the descriptions above. +- Must display shring's webring links. - **heuristic**: you shouldn't have to go looking into the html source or some other voodoo shit just to find the next site in the webring -- must **not** be corpo slopware -- must **not** contain bigotry or hatred +- Must **not** be corpo slopware. +- Must **not** contain bigotry or hatred.
[return](#toc)
-## do i need to use unix? +<h3 id="do-i-need-to-use-unix">DO I NEED TO USE UNIX</h3>
-the "-y" in "unix**-y**" is important. -if you (and by extension, your personal site) +The "-y" in "unix**-y**" is important. +If you (and by extension, your personal site) appreciate free software, the unix philosophy, hacking, and tinkering, then the shring welcomes you, @@ -119,24 +124,24 @@ os choice notwithstandding.
[return](#toc)
-## can my site have javascript? +<h3 id="can-i-use-javascript">CAN I USE JAVASCRIPT</h3>
-although shring is proudly [no-js](https://no-js.club/), +Although shring is proudly [no-js](https://no-js.club/), and you certainly get bonus points for a static, javascript-free website,\ **member sites are welcome to include javascript**.
-**however**, -if your site makes use of **bloated frameworks**, +**However**, +If your site makes use of **bloated frameworks**, **runs poorly** on older hardware, **serves ads**, or **tracks** its visitors, **it does not belong in the shring**.
[return](#toc)
-## how can i join? +<h3 id="how-can-i-join">HOW CAN I JOIN</h3>
-to apply, compile the following information: +To apply, compile the following information:
- the **name** of your site - your **url** @@ -149,25 +154,25 @@ to apply, compile the following information: - your **name**: - this can be a full name, nickname, username, whatever you want
-please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh). +Please email your application to [daniel@ficd.sh](mailto:daniel@ficd.sh).
-you will receive a response via [carrier pigeon](https://nameecho.com/carrior) +You will receive a response via [carrier pigeon](https://nameecho.com/carrior) within 300 business years. if you prefer to be contacted by message-in-a-bottle, include the name of the nearest body of water with an accessible shoreline, and your request will be accommodated.
-preferably before applying, +Preferably before applying, add your shring links to your website:
- `shring.sh/your-slug/previous` - `shring.sh` - `shring.sh/your-slug/next`
-you are responsible for styling and positioning them +You are responsible for styling and positioning them however you see fit. -optional `88x31px` banners are coming soon. +Optional `88x31px` banners are coming soon.
we also have a [mailing list](https://lists.jdugan6240.dev/mailman3/lists/shring.lists.jdugan6240.dev), which is used for announcements, @@ -179,13 +184,13 @@ The mailing list is maintained by [jdugan6240](https://jdugan6240.dev).
[return](#toc)
-## how is shring built? +<h3 id="architecture">ARCHITECTURE</h3>
-shring's source is available on [git.ficd.sh](https://git.ficd.sh/ficd/shring). -the webring "backend" (static pages with html redirects) +The source code for shring is available's [git.ficd.sh](https://git.ficd.sh/ficd/shring). +Rhe webring "backend" (static pages with html redirects) is built using [ringfairy](https://github.com/k3rs3d/ringfairy).
-additional pages (including this one) +Additional pages (including this one) are generated by a shell script. they are written in markdown, converted to html with pandoc, -- 2.50.1
_______________________________________________ Shring mailing list -- shring@lists.jdugan6240.dev To unsubscribe send an email to shring-leave@lists.jdugan6240.dev
--- pages/faq.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/pages/faq.md b/pages/faq.md index 8b229ff..be5ffaa 100644 --- a/pages/faq.md +++ b/pages/faq.md @@ -29,10 +29,11 @@ $ man shring - [DEPENDENCIES](#dependencies) - [CAN I USE JAVASCRIPT](#can-i-use-javascript) - [HOW CAN I JOIN](#how-can-i-join) +- [ARCHITECTURE](#architecture) <!--toc:end--> -<h3 id="description">DESCRIPTION</h3> +### DESCRIPTION The shring (pronounced "shring") is **a small web of unix-y personal sites.** @@ -56,7 +57,7 @@ If a site meets these requirements, it's shringworthy. [return](#toc) -<h3 id="examples">EXAMPLES</h3> +### EXAMPLES $ shring definition @@ -100,7 +101,7 @@ kernel de(output truncated) [return](#toc) -<h3 id="dependencies">DEPENDENCIES</h3> +### DEPENDENCIES Your website: @@ -113,7 +114,7 @@ Your website: [return](#toc) -<h3 id="do-i-need-to-use-unix">DO I NEED TO USE UNIX</h3> +### DO I NEED TO USE UNIX The "-y" in "unix**-y**" is important. If you (and by extension, your personal site) @@ -124,7 +125,7 @@ os choice notwithstandding. [return](#toc) -<h3 id="can-i-use-javascript">CAN I USE JAVASCRIPT</h3> +### CAN I USE JAVASCRIPT Although shring is proudly [no-js](https://no-js.club/), and you certainly get bonus points for a @@ -139,7 +140,7 @@ If your site makes use of **bloated frameworks**, [return](#toc) -<h3 id="how-can-i-join">HOW CAN I JOIN</h3> +### HOW CAN I JOIN To apply, compile the following information: @@ -184,7 +185,7 @@ The mailing list is maintained by [jdugan6240](https://jdugan6240.dev). [return](#toc) -<h3 id="architecture">ARCHITECTURE</h3> +### ARCHITECTURE The source code for shring is available's [git.ficd.sh](https://git.ficd.sh/ficd/shring). Rhe webring "backend" (static pages with html redirects) -- 2.50.1
Thanks!
I've applied these and made some small edits on top of them.
-- Daniel Fichtinger
Computer programmer.
https://ficd.sh https://git.ficd.sh https://codeberg.org/ficd
participants (1)
-
Daniel Fichtinger -
Jacob Haussman -
Zunda