diff options
| -rw-r--r-- | docs/01-install.html (renamed from docs/install.html) | 2 | ||||
| -rw-r--r-- | docs/02-bootloader.html (renamed from docs/bootloader.html) | 2 | ||||
| -rw-r--r-- | docs/03-networking.html (renamed from docs/networking.html) | 2 | ||||
| -rw-r--r-- | docs/04-autils.html (renamed from docs/packagemanager.html) | 2 | ||||
| -rw-r--r-- | docs/05-using_apkg.html (renamed from docs/using_autils.html) | 2 | ||||
| -rw-r--r-- | docs/06-apkg_helpers.html (renamed from docs/apkg_helpers.html) | 2 | ||||
| -rw-r--r-- | docs/07-writing_abuild.html (renamed from docs/writing_abuild.html) | 2 | ||||
| -rw-r--r-- | docs/08-contributing-docs.html | 215 | ||||
| -rw-r--r-- | docs/index.html | 16 |
9 files changed, 231 insertions, 14 deletions
diff --git a/docs/install.html b/docs/01-install.html index aac29e84..8fba7df3 100644 --- a/docs/install.html +++ b/docs/01-install.html @@ -374,7 +374,7 @@ Create a symlink from <code>/etc/sv/<service></code> to <code>/var/service <li>Run <code>updateconf</code> to update config files in <code>/etc</code> after package upgrades.</li> </ul> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/02-bootloader.html">Bootloader -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/bootloader.html b/docs/02-bootloader.html index 76edabfe..e6904b76 100644 --- a/docs/bootloader.html +++ b/docs/02-bootloader.html @@ -234,7 +234,7 @@ <pre><code># grub-mkconfig -o /boot/grub/grub.cfg </code></pre> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/03-networking.html">Networking -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/networking.html b/docs/03-networking.html index d641a353..7324416f 100644 --- a/docs/networking.html +++ b/docs/03-networking.html @@ -312,7 +312,7 @@ DisablePeriodicScan=true # ln -s /etc/sv/udhcpc /var/service </code></pre> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/04-autils.html">Package Manager -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/packagemanager.html b/docs/04-autils.html index af1e1b6c..df0e0c4b 100644 --- a/docs/packagemanager.html +++ b/docs/04-autils.html @@ -486,7 +486,7 @@ $ apkg-redundantdeps $ apkg-redundantdeps -f </code></pre> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/05-using_apkg.html">Using autils -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/using_autils.html b/docs/05-using_apkg.html index 55fdc805..99904229 100644 --- a/docs/using_autils.html +++ b/docs/05-using_apkg.html @@ -345,7 +345,7 @@ apkg-orphan # review packages to potentially remove # inspect $APKG_WORK_DIR/apkg-src-mypkg and apkg-pkg-mypkg </code></pre> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/06-apkg_helpers.html">apkg helper scripts -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/apkg_helpers.html b/docs/06-apkg_helpers.html index cc56ebee..e68d3ac3 100644 --- a/docs/apkg_helpers.html +++ b/docs/06-apkg_helpers.html @@ -230,7 +230,7 @@ apkg-redundantdeps -f mypkg # fix by removing redundant entries apkg-redundantdeps -f # fix all packages </code></pre> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/07-writing_abuild.html">Writing an abuild recipe -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/writing_abuild.html b/docs/07-writing_abuild.html index 3dd20471..848784d8 100644 --- a/docs/writing_abuild.html +++ b/docs/07-writing_abuild.html @@ -359,7 +359,7 @@ echo "hello was installed!" <li>Set <code>APKG_KEEP_WORKDIR=1</code> in your environment to inspect the build tree when debugging a failed build.</li> </ul> -<a href="/docs/"><- back to docs</a> +<div style="display:flex;justify-content:space-between;margin-top:1.5em"><a href="/docs/"><- back to docs</a><a href="/docs/08-contributing-docs.html">Contributing documentation -></a></div> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> diff --git a/docs/08-contributing-docs.html b/docs/08-contributing-docs.html new file mode 100644 index 00000000..dc0c3438 --- /dev/null +++ b/docs/08-contributing-docs.html @@ -0,0 +1,215 @@ +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <title>Alice Linux - docs</title> + <link rel="icon" type="image/svg+xml" href="/files/favicon.svg"> + <style> + :root { + color-scheme: dark; + --bg: #0d0d0d; + --bg-alt: #141414; + --bg-code: #1a1a1a; + --fg: #e0e0e0; + --fg-dim: #888; + --accent: #a8a8a8; + --accent-hover: #e0e0e0; + --border: #222; + } + * { margin: 0; padding: 0; box-sizing: border-box; } + body { + font-family: "Terminus", "Monaco", "Cascadia Code", "Fira Code", "JetBrains Mono", "SF Mono", Consolas, monospace; + font-size: 15px; + line-height: 1.6; + max-width: 88ch; + margin: 0 auto; + padding: 2em 1.5em; + background: var(--bg); + color: var(--fg); + -webkit-font-smoothing: antialiased; + } + h1, h2, h3, h4 { font-weight: 600; line-height: 1.3; } + h1 { font-size: 1.75rem; margin-bottom: 0.6em; } + h2 { font-size: 1.3rem; margin: 1.6em 0 0.5em; } + h3 { font-size: 1.1rem; margin: 1.4em 0 0.4em; } + h4 { font-size: 1rem; margin: 1.2em 0 0.3em; } + p { margin: 0 0 1em; } + a { + color: var(--accent); + text-decoration: none; + } + a:hover { color: var(--accent-hover); text-decoration: underline; } + nav { margin-bottom: 1.5em; } + nav a { color: var(--fg-dim); font-size: 0.9em; } + nav a:hover { color: var(--accent); } + nav span { color: var(--border); margin: 0 0.3em; } + hr { + border: 0; + border-top: 1px solid var(--border); + margin: 1.5em 0; + } + pre, code { font-family: "SF Mono", "Cascadia Code", "Fira Code", "JetBrains Mono", Consolas, monospace; font-size: 0.9em; } + code { + background: var(--bg-code); + padding: 0.15em 0.4em; + border-radius: 3px; + color: #c0c0c0; + } + pre { + background: var(--bg-code); + border: 1px solid var(--border); + border-radius: 4px; + padding: 1em; + overflow-x: auto; + margin: 1em 0; + line-height: 1.45; + } + pre code { + background: none; + padding: 0; + border-radius: 0; + } + img { + display: block; + max-width: 100%; + height: auto; + margin: 1em 0; + border-radius: 4px; + } + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 3px solid var(--border); + color: var(--fg-dim); + } + table { + width: 100%; + border-collapse: collapse; + margin: 1em 0; + } + th, td { + padding: 0.5em 0.6em; + text-align: left; + border-bottom: 1px solid var(--border); + } + th { + font-weight: 600; + border-bottom-color: #333; + } + tr:last-child td { border-bottom: none; } + ul, ol { margin: 0 0 1em 1.5em; } + li { margin-bottom: 0.3em; } + input, button, textarea { font: inherit; color: inherit; } + .ports-toolbar { + display: flex; + flex-wrap: wrap; + gap: 0.5em; + margin-bottom: 1em; + } + .ports-toolbar button { + background: none; + border: none; + border-bottom: 2px solid transparent; + padding: 0.3em 0; + cursor: pointer; + color: var(--fg-dim); + font-size: 0.9em; + } + .ports-toolbar button.active { + color: var(--accent); + border-bottom-color: var(--accent); + } + .ports-toolbar button:hover { color: var(--fg); } + .ports-toolbar input { + flex: 1 1 18em; + min-width: 0; + background: var(--bg-alt); + border: 1px solid var(--border); + border-radius: 3px; + padding: 0.4em 0.6em; + } + .ports-toolbar input:focus { outline: none; border-color: var(--accent); } + .ports-count { margin-bottom: 0.8em; color: var(--fg-dim); font-size: 0.9em; } + #commits { list-style: none; margin: 0; } + #commits li { + padding: 0.8em 0; + border-bottom: 1px solid var(--border); + display: flex; + align-items: flex-start; + gap: 0.8em; + } + #commits li:last-child { border-bottom: none; } + .commit-hash { + font-family: "SF Mono", "Cascadia Code", "Fira Code", "JetBrains Mono", Consolas, monospace; + font-size: 0.8em; + color: var(--fg-dim); + white-space: nowrap; + min-width: 7em; + } + .commit-msg { flex: 1; word-break: break-word; } + .commit-meta { + font-size: 0.85em; + color: var(--fg-dim); + white-space: nowrap; + text-align: right; + min-width: 9em; + } + #commits-loading { + text-align: center; + padding: 1.5em; + color: var(--fg-dim); + display: none; + } + #commits-error { + text-align: center; + padding: 1em; + color: #e77; + display: none; + } + .dl-table td:nth-child(1) { width: 60%; } + .dl-table td:nth-child(2) { width: 15%; text-align: right; } + .dl-table td:nth-child(3) { width: 25%; white-space: nowrap; } + .dl-empty { color: var(--fg-dim); font-style: italic; } + </style> +</head> +<body> +<div class="centered-wrapper"> + <nav> + <a href="/">home</a><span> / </span><a href="/docs">docs</a><span> / </span><a href="/ports.html">ports</a><span> / </span><a href="/commits.html">commits</a><span> / </span><a href="/download.html">download</a><span> / </span><a href="/development.html">development</a><span> / </span><a href="/community.html">community</a><span> / </span><a href="/donate.html">donate</a> + </nav> + <hr> +<a href="/docs/"><- back to docs</a> + +<h1>Contributing documentation</h1> +<p>Alice Linux documentation lives in the <code>docs/</code> directory of the <a href="https://codeberg.org/emmett1/alicelinux">main repository</a>. Improvements, corrections, and new guides are welcome.</p> +<h2>Editing existing docs</h2> +<p>Pick a file from <code>docs/</code>, make your changes, and submit a pull request. Each doc is a standard markdown file that gets converted to HTML by <code>utils/buildsite.sh</code>.</p> +<p>Docs use numbered prefixes (<code>01-</code>, <code>02-</code>, etc.) to define reading order. If you insert a new doc between existing ones, renumber as needed so the sequence stays consistent.</p> +<h2>Adding a new doc</h2> +<p>Create a new markdown file in <code>docs/</code> with the next available number prefix. The first line must be an ATX heading (<code># Title</code>) -- this is what appears in the docs index and the next-doc navigation link.</p> +<p>Keep the scope focused. If the topic is already covered by an existing doc, expand that doc instead of creating a competing one.</p> +<h2>Style conventions</h2> +<ul> +<li>Follow standard markdown format.</li> +<li>Avoid tables.</li> +</ul> +<h2>Previewing locally</h2> +<p>Run <code>./utils/buildsite.sh</code> from the repo root (requires <code>cmark</code> and <code>curl</code>). Start a local server to view the result:</p> +<pre><code>busybox httpd -p 8080 -h public +</code></pre> +<p>Then open <code>http://localhost:8080</code> in a browser.</p> +<h2>Submitting changes</h2> +<ol> +<li>Fork the repository on Codeberg.</li> +<li>Make your changes in a feature branch.</li> +<li>Run <code>./utils/buildsite.sh</code> and verify the output.</li> +<li>Submit a pull request against the <code>main</code> branch.</li> +</ol> + +<a href="/docs/"><- back to docs</a> + <hr> + <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> +</div> +</body> +</html> diff --git a/docs/index.html b/docs/index.html index 5ba0e91b..3b054288 100644 --- a/docs/index.html +++ b/docs/index.html @@ -183,14 +183,16 @@ <p>This section covers the main parts of <strong>Alice Linux</strong>: installation, package management, networking, service supervision, etc.</p> <ul> -<li><a href="./apkg_helpers.html">apkg helper scripts</a></li> -<li><a href="./bootloader.html">Bootloader</a></li> -<li><a href="./install.html">Install Alice</a></li> -<li><a href="./networking.html">Networking</a></li> -<li><a href="./packagemanager.html">Package Manager</a></li> -<li><a href="./using_autils.html">Using autils</a></li> -<li><a href="./writing_abuild.html">Writing an abuild recipe</a></li> +<li><a href="./01-install.html">Install Alice</a></li> +<li><a href="./02-bootloader.html">Bootloader</a></li> +<li><a href="./03-networking.html">Networking</a></li> +<li><a href="./04-autils.html">Package Manager</a></li> +<li><a href="./05-using_apkg.html">Using autils</a></li> +<li><a href="./06-apkg_helpers.html">apkg helper scripts</a></li> +<li><a href="./07-writing_abuild.html">Writing an abuild recipe</a></li> +<li><a href="./08-contributing-docs.html">Contributing documentation</a></li> </ul> +<p>Documentation improvements are welcome. Visit the <a href="https://codeberg.org/emmett1/alicelinux/src/branch/main/docs">docs directory</a> to contribute.</p> <hr> <p style="color: var(--fg-dim); font-size: 0.85em;">Copyright © Alice Linux, 2024-2026</p> </div> |