Our great sponsors
-
-
documentation-framework
"The Grand Unified Theory of Documentation" (David Laing) - a popular and transformative documentation authoring framework
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
This results in two websites: - the documentation of the language on the "main" website, https://arkscript-lang.dev ; - the technical documentation (+ modules) on doxygen: https://arkscript-lang.dev/impl/
I came here to mention ReadTheDocs. https://diataxis.fr/ may predate the GUT but it's basically the same content. I'm especially pleased with the glossary idea, though: So many software projects forget a domain glossary and then you have seventeen overloaded terms for twenty-five concepts. Consistent naming throughout -- Apps-Hungarian if you want to go whole-hog with it -- can be the difference in maintainability between tolerable-if-difficult and just stab me now.