Skip to content

Commit 176fc51

Browse files
committed
Add contributing guide
1 parent 6a76b1b commit 176fc51

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

CONTRUBUTING.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Gramps Web Docs Contributing Guide
2+
3+
Thanks for helping to improve the Gramps Web documentation! This guide will help you get started with contributing.
4+
5+
## Finding your way around
6+
7+
The documentation pages are written in Markdown and stored in the `docs` directory. Each page on [grampsweb.org](https://www.grampsweb.org/) corresponds to a `.md` file in this directory.
8+
9+
The navigation structure is defined in the `mkdocs.yml` file at the root of the repository. This file controls how the pages are organized and displayed in the sidebar.
10+
11+
## Making changes
12+
13+
To make changes to the documentation, simply change the relevant Markdown files in the `docs` directory and submit a pull request.
14+
15+
If you are proficient with git, you can clone the repository, make your changes locally, and push them to your fork. If you're not familiar with git, you can also edit files directly on Github using the web interface.
16+
17+
## Adding new pages
18+
19+
To add a new page to the documentation, create a new Markdown file in the `docs` directory and add it to the `mkdocs.yml` file under the appropriate section. Make sure to follow the existing structure and formatting.
20+
21+
## Previewing changes
22+
23+
If you are just editing or adding Markdown to a page, there may not be a need to preview your changes. However, if you are making significant changes or adding new pages, you can preview your changes locally by following these steps:
24+
25+
1. Install the necessary dependencies:
26+
27+
```bash
28+
python -m pip install -r requirements.txt
29+
```
30+
31+
2. Run the MkDocs development server:
32+
33+
```bash
34+
python -m mkdocs serve -a localhost:8211
35+
```
36+
37+
3. Open your web browser and go to [http://localhost:8211](http://localhost:8211) to see your changes live. The web server will automatically reload when you make changes to the Markdown files.

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,9 @@ For the source code of Gramps Web, please see
77
- [Gramps Web API](https://github.com/gramps-project/gramps-web-api/) for the (Python) backend
88
- [Gramps Web Frontend](https://github.com/gramps-project/gramps-web) for the (Javascript) frontend
99

10-
Please use those repositories for reporting issues or feature requests.
10+
Please use those repositories for reporting issues or feature requests.
11+
12+
13+
## Contributing
14+
15+
Contributions to the documentation are welcome! Please see the [Contributing Guide](CONTRIBUTING.md) for details.

0 commit comments

Comments
 (0)