add diataxis info to docs readme (#548)

* add loca build info to htmlserve

* add info about diataxis to the docs/readme

* add diataxis img
This commit is contained in:
Fabio Pliger
2022-06-24 15:06:47 -05:00
committed by GitHub
parent c7942d7d8f
commit 96a73e31f3
3 changed files with 12 additions and 1 deletions

View File

@@ -31,7 +31,8 @@ shell:
@echo 'conda activate $(env)'
htmlserve:
python -m http.server -d "$(BUILDDIR)/html/"
@echo 'visit docs at http://localhost:8080'
python -m http.server -d "$(BUILDDIR)/html/" 8080
livehtml:
sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

View File

@@ -9,6 +9,16 @@ 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:
![pyodide-pyscript](./img/diataxis.png)
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

BIN
docs/img/diataxis.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 108 KiB