Skip to content

Commit 2398137

Browse files
committed
[DX] Mention Doctor Rst in CONTRIBUTING.md
1 parent 507c89c commit 2398137

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,21 @@ Thanks to [Yarn Workspaces](https://yarnpkg.com/features/workspaces), you can al
9090
- `yarn run check`: run the formatter, linter, and sort imports for **all** packages, and fails if any modifications
9191
- `yarn run check --write`: run the formatter, linter, imports sorting for **all** packages, and write modifications
9292

93+
### Working on documentation
94+
95+
Symfony UX documentation is written in ReStructuredText (`.rst`) and is located in the `docs/` directory
96+
of each package.
97+
98+
When contributing to the documentation, please make sure to follow the Symfony
99+
[documentation guidelines](https://symfony.com/doc/current/contributing/documentation/index.html).
100+
101+
To verify your changes locally, you can use the `oskarstark/doctor-rst` Docker image. Run the following
102+
command from the root directory of the projet:
103+
104+
```shell
105+
docker run --rm -it -e DOCS_DIR='/docs' -v ${PWD}:/docs oskarstark/doctor-rst -vvv
106+
```
107+
93108
## Useful Git commands
94109

95110
1. To keep your fork up-to-date with the upstream repository and `2.x` branch, you can run the following commands:

0 commit comments

Comments
 (0)