1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
# Contributing to Documentation
!!! note "Prerequisites"
This guide assumes you are already familiar with our [setup guide](./setup.md).
Create a new branch for your documentation changes:
```sh
git checkout -b docs/your-feature-name
```
## Previewing Documentation Changes
!!! example "Local Development"
1. From the project root directory, start the MkDocs development server:
```sh
mkdocs serve
```
2. Open your browser and navigate to `http://127.0.0.1:8000`
The preview will automatically update as you make changes to the documentation files.
## Making Documentation Changes
!!! info "Documentation Structure"
- Documentation source files are written in Markdown and located in the `docs/` directory
- Images and other assets should be placed in the `docs/assets/` directory
- The documentation structure is defined in `mkdocs.yaml` at the root of the repository
## Submitting Your Changes
1. Commit your changes with a descriptive message:
```sh
git add docs/
git commit -m "docs: describe your changes here"
```
2. Push your changes to your fork:
```sh
git push origin docs/your-feature-name
```
3. Create a Pull Request (PR) from your fork to the main
[recipe-scrapers](https://github.com/hhursev/recipe-scrapers) repository.
!!! success "PR Preview"
When you create a PR, a special preview URL will be generated where your documentation
changes can be reviewed. This will make it easy for maintainers to see your changes in action.
## Documentation Style Guidelines
!!! note "Style Guide"
- Use clear, concise language
- Include code examples where appropriate
- Follow the existing documentation structure
- Add screenshots or diagrams when they help explain concepts
- Ensure all links are working
- Use proper Markdown formatting
## Need Help?
!!! question "Getting Support"
If you have questions or need assistance with documentation contributions, please:
- Open an [issue on GitHub](https://github.com/hhursev/recipe-scrapers/issues)
- Check existing documentation for reference
|
