1
1
mirror of https://github.com/NixOS/mobile-nixos.git synced 2024-12-13 20:44:52 +03:00
mobile-nixos/doc
2020-05-04 19:44:30 -04:00
..
_support doc: Fix multi-paragraphs admonitions 2020-05-04 19:44:30 -04:00
in-depth doc: Add missing language to fenced code blocks 2020-04-06 19:57:40 -04:00
.gitignore doc: Adds documentation and documentation support 2019-11-15 22:02:06 -05:00
about.adoc doc: Add about page 2020-05-04 19:29:31 -04:00
boot_process.adoc doc: Document launching the simulator 2020-03-01 17:33:25 -05:00
default.nix doc: Add a contributing document 2020-04-29 18:02:34 -04:00
getting-started.adoc doc: Add link to contributing guide in getting started 2020-04-29 18:02:34 -04:00
pkgs.nix doc: Adds documentation and documentation support 2019-11-15 22:02:06 -05:00
porting-guide.adoc doc: Add menuconfig notes in the emrbyonic porting guide 2020-03-27 16:36:15 -04:00
README.md doc: Updates internal documentation notes 2019-11-15 22:02:10 -05:00
resources.adoc doc: Add link to README in resources 2020-04-06 19:57:23 -04:00

Documentation internal notes

This document is not to be generated into the website/documentation.


Implementation notes

This documentation folder generates the Mobile NixOS website and documentation as a whole.

The documentation is to be written in asciidoc, and converted through a custom pipeline through the Asciidoctor API. Markdown files are accepted in the pipeline, but frowned upon except for the simplest documentation articles.

The build pipeline can be improved upon, and contributions doing so are welcome!

Main Page and News

To reduce the amount of irrelevant contents in the documentation folders, the main page, and news entries from the Mobile NixOS website have been split into the Mobile NixOS website repository.

This also allows more leeway to add additional non-documentation relevant pages to the website. The documentation folder of the main repository is used solely for documentation.

Devices list

The devices folder is special and assumes it will be replaced in-place with asciidoc source files generated from a build outside of the main documentation build. This is because it is generated from the actual device descriptions from the repository.

Sitemap

The sitemap is simply a dump of all document files and "catalogs" from as parsed by Asciidoctor.