About the Lino documentation¶
The Lino documentation is distributed over several documentation trees, each of them targeted at different audiences.
- main website¶
A doctree for “everybody”, including (future) site operators, stakeholders and consultants.
- user guide¶
A doctree for end users, key users and support providers
- hosting guide¶
A doctree for hosting providers
- developer guide¶
A doctree for application developers and core developers.
The source code of these documentation trees is published in code repositories as free content under the same licence as the source code of Lino itself. You can find the source code by clicking on the “Source code” in the footer of every web page.
Technical documentation includes topic guides, reference documentation, the changelog and others. For some applications we maintain also end-user documentation in different languages. These are independent doctrees, not a translation of the technical docs.
- reference documentation¶
A section of documentation pages that are intermediate between developer guide and user guide.
Reference documentation is not only for developers, it can be a valuable help for support providers and motivated key users.
Reference docs contain class descriptions for database models and data views.
Reference docs are not translated like the user guide.
- local help pages¶
A doctree that is automatically generated by a Lino site. These pages are what opens when you click the help button (?).
See also About local help pages.
- site documentation¶
Another name for local help pages.
- doctree¶
Abbreviation for documentation tree.
- documentation tree¶
A stand-alone hierarchy of content pages that are rendered as a website or a book.
- end-user documentation¶
Documentation for end users of a given Lino site. Written in the language(s) requested by the site operator.
- developer documentation¶
Documentation written for software developers and motivated site experts. Only in English. May include tested source code snippets and part of the test suite.
