Skip to content

Commit db2e8c9

Browse files
authored
Add info on how to make docs for exs
1 parent a1c74fe commit db2e8c9

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

CONTRIBUTING.MD

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,21 +8,24 @@ The intention set for this repository is for it to be a place that's built by th
88

99
### Table of contents:
1010

11-
**[Contributing a new example](Contributing-a-new-example)**
12-
**[Recommended guidelines for an example](Recommended-guidelines-for-an-example)**
13-
**[Running the tests](Running-the-tests)**
14-
**[Contributing a new resource](Contributing-a-new-resource)**
15-
**Recommended guidelines for a resource**
16-
**[Reporting a bug](Reporting-a-bug)**
17-
**[Opening an enhancement issue](Opening-an-enhancement-issue)**
11+
- **[Contributing a new example](Contributing-a-new-example)**
12+
- **[Recommended guidelines for an example](Recommended-guidelines-for-an-example)**
13+
- **[Running the tests](Running-the-tests)**
14+
15+
- **[Contributing a new resource](Contributing-a-new-resource)**
16+
- **Recommended guidelines for a resource**
17+
18+
- **[Reporting a bug](Reporting-a-bug)**
19+
20+
- **[Opening an enhancement issue](Opening-an-enhancement-issue)**
1821

1922
### Contributing a new example
2023

2124
We try not to have strong boundaries in what kinds of contributions are accepted in this repository as we want contributors to be able to be as creative as they can. Still, we do have some recommendations in place so the examples in this repository offer a consistent experience to the users.
2225

2326
#### Recommended guidelines for an example
2427

25-
Here are some great examples of contributions:
28+
Here are some great general examples of what a good contribution might be(not restrict:
2629

2730
- it showcases PyScript power to leverage other tools (either from the JavaScript or the Python ecosystem)
2831
- it expands on the PyScript documentation, making the use of PyScript clearer to users
@@ -33,6 +36,11 @@ Adding meta-data:
3336
- adding tags to your example will help us organize this repository in a much more meaningful way. Example tags come at the beginning of your main `HTML` file in the form of a comment. See the [example](examples/hello_world.html)
3437
- you're also welcome to add your email or name or other forms of contact information in the header at the beginning of the file. See the [example](examples/hello_world.html)
3538

39+
Adding docs:
40+
41+
PyScript strives to be accessible to beginners, if you're writing code that might be confusing please add comments explaining your choices.
42+
If you need to write further docs for your program feel free to create a `README.md` file with instructions about installation, use and other details on how to run your example.
43+
3644
#### Running tests
3745

3846
To run the tests it's necessary to have a local build of PyScript running, you can learn more about it in the [PyScript docs](https://docs.pyscript.net/latest/).

0 commit comments

Comments
 (0)