From: Alyssa Ross <hi@alyssa.is>
To: discuss@spectrum-os.org
Subject: New documentation site is live!
Date: Thu, 19 May 2022 10:42:01 +0000 [thread overview]
Message-ID: <20220519104201.zqqn32k6rzmanedo@eve> (raw)
[-- Attachment #1: Type: text/plain, Size: 755 bytes --]
We finally have an online render of the new documentation I've been
writing:
https://spectrum-os.org/doc/
Let me know if anything doesn't look right.
This documentation lives in the "Documentation" directory in the
Spectrum repository. The online version will be automatically updated
whenever changes are pushed.
I'm not sure what to put on the index page. I think maybe it would make
sense to just merge all the content that's currently on the rest of the
website into the documentation, but I'm not sure yet.
It's going to be really important for Spectrum to have solid
documentation. I recently watched a talk about the Diátaxis system[1],
and I think it would be a good model for us to follow.
[1]: https://diataxis.fr/
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]
reply other threads:[~2022-05-19 10:42 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220519104201.zqqn32k6rzmanedo@eve \
--to=hi@alyssa.is \
--cc=discuss@spectrum-os.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).