Skip to content

Commit a7c641c

Browse files
authored
Merge pull request #1862 from Suvink/pe
Add documentation instructions
2 parents 3753ec6 + 1241554 commit a7c641c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,26 @@ Before you contribute, read the following guidelines to understand how you can s
1818

1919
For an overview of the general voice, tone, content style, and text formatting to follow when contributing to Choreo documentation, see [Choreo Documentation Guidelines and Best Practices](https://github.com/wso2/docs-choreo-dev/wiki/Choreo-Documentation-Guidelines-and-Best-Practices)
2020

21+
### Making changes to the documentation
22+
23+
1. Switch to the `PE` branch.
24+
```
25+
git checkout PE
26+
```
27+
28+
2. The repository has two documentation directories, aligned with the perspectives in the Choreo Console:
29+
- `en/developer-docs` - Documentation for the Development View.
30+
- `en/pe-docs` - Documentation for the Platform Operations View.
31+
32+
If a change applies only to one perspective, update the documentation in the relevant directory.
33+
If a change applies to both perspectives, update both directories.
34+
35+
⚠️ ***Note: Console navigation and documentation grouping differ between the perspectives, so ensure content is placed and structured appropriately.***
36+
37+
3. Make the necessary changes to the documentation in the relevant directory.
38+
4. Commit and push the changes to your forked repository.
39+
5. Send a pull request to the `PE` branch of this repository.
40+
2141
We look forward to your contributions.
2242

2343
## Run the project locally with Devcontainers

0 commit comments

Comments
 (0)