dc84d7c1b5
* checkpoint: added some text * checkpoint: added setting up the environment, tips for writing good issues * continuing to fill it out * added more detailed description of the process of creating a change and some other cleanup. * added a getting started section and cleaned up the grammar. This ready for the PR now * forgot to add the new section to the TOC * Minor fixes Co-authored-by: Kevin Goldsmith <kgoldsmith@anaconda.com> Co-authored-by: Matt Kramer <mkramer@anaconda.com>
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
Documentation Principles
The PyScript documentation is based on a documentation framework called Diátaxis. 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, fulfills 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.
Setup
The docs directory in the pyscript repository contains a
Sphinx documentation project. Sphinx is a system
that takes plaintext files containing documentation written in Markdown, along with
static files like templates and themes, to build the static end result.