* New documentation site is live!
@ 2022-05-19 10:42 Alyssa Ross
0 siblings, 0 replies; only message in thread
From: Alyssa Ross @ 2022-05-19 10:42 UTC (permalink / raw)
To: discuss
[-- 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 --]
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-05-19 10:42 UTC | newest]
Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2022-05-19 10:42 New documentation site is live! Alyssa Ross
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).