jprdonnelly/pyscript
1
0
Fork 0
mirror of https://github.com/pyscript/pyscript.git synced 2025-12-19 18:27:29 -05:00
Code Issues Projects Releases Wiki Activity

Add docs on how to contribute to docs (#720)

Browse Source 
* Add docs on how to contribute to docs

* Reword some phrases
This commit is contained in:
Mariana Meireles
2022-09-08 11:38:31 +00:00
committed by GitHub
parent 6c80db810f
commit 066ecbe022
2 changed files with 17 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
CONTRIBUTING.md
View File

@@ -73,27 +73,29 @@ If you have questions about the project, using PyScript, or anything else, pleas
Now that node and npm have both been updated `make setup` should work, and you can continue [setting up your local environment](#setting-up-your-local-environment) without problems (hopefully).
## Creating a Pull Request
### Building the docs
After you fork PyScript make sure to add a new remote. You can do that using the command:
To build the documentation locally first make sure you are in the `docs` directory.
You'll need `make` and `conda` installed in your machine. The rest of the environment should be automatically download and created for you once you use the command:
```
git remote add remote_nickname remote_url
make setup
```
You should have one remote that corresponds to your local repository and one remote that corresponds the upstream PyScript repository.
Use `conda activate $environment_name` to activate your environment.
We recommend you to create a new local branch and develop your changes in this branch. You can do that by using:
To add new information to the documentation make sure you conform with PyScript's code of conduct and with the general principles of Diataxis. Don't worry about reading too much on it, just do your best to keep your contributions on the correct axis.
Write your documentation files using [Markedly Structured Text](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html), which is very similar to vanilla Markdown but with some addons to create the documentation infrastructure.
Once done, initialize a server to check your work:
```
git checkout -b branch_name #creates new branch
git checkout branch_name #goes to branch
make livehtml
```
It's not mandatory but it's advisible to have one issue that is related to your PR, the more information you give and the clearer you can communicate your ideas the faster maintainers will be able to review your changes and merge your PR.
Please try to keep the changes on your PR within the issue's scope. In case you don't have a related issue, limit the your PR's scope in a way that a short sentence summarizes its contents. This sentence should be the name of your PR. If you can't think of a sentence that summarizes your PR well, might be a sign that you need to split it in two or more PRs!
Visible here: http:///127.0.0.1:8000
## Places to start

4
docs/README.md
View File

@@ -25,3 +25,7 @@ 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
static files like templates and themes, to build the static end result.
### Build
To learn how to build the docs, head over the [CONTRIBUTING](../CONTRIBUTING.md) page.