mirror of
https://github.com/pyscript/pyscript.git
synced 2026-02-17 01:00:41 -05:00
96a73e31f3
* add loca build info to htmlserve * add info about diataxis to the docs/readme * add diataxis img
28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# PyScript documentation
|
|
|
|
Welcome to the PyScript documentation directory, where you can find
|
|
and contribute to discussions around PyScript and related topics.
|
|
|
|
## Getting started
|
|
|
|
Before you start contributing to the documentation, it's worthwhile to
|
|
take a look at the general contributing guidelines for the PyScript project. You can find these guidelines here
|
|
[Contributing Guidelines](https://github.com/pyscript/pyscript/blob/main/CONTRIBUTING.md)
|
|
|
|
## Documentation Principles
|
|
|
|
The PyScript documentation is based on a documentation framework called [Diátaxis](https://diataxis.fr/). This framework helps to solve the problem of structure in technical documentation and identifies four modes of documentation - **tutorials, how-to guides, technical reference and explanation**. Each one of these modes answers to a different user need, fulfils a different purpose and requires a different approach to its creation.
|
|
|
|
The picture below gives a good visual representation of that separation of concerns:
|
|
|
|
|
|
|
|
So, please keep that in mind when contributing to the project documentation. For more information on, make sure to check [their website](https://diataxis.fr/).
|
|
|
|
### Setup
|
|
|
|
The `docs` directory in the pyscript repository contains a
|
|
[Sphinx](https://www.sphinx-doc.org/) documentation project. Sphinx is a system
|
|
that takes plaintext files containing documentation written in Markdown, along with
|
|
and static files like templates and themes, to build the static end result.
|