Skip to content

Commit d4ae59b

Browse files
Update README with instructions for making edits to the handbook
1 parent 67c8224 commit d4ae59b

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
1-
# SSI Handbook
1+
# SSI Handbook
2+
Please note that this document is a work in progress.
3+
4+
## Editing the SSI Handbook
5+
6+
To make changes to the SSI Handbook, follow these steps:
7+
8+
1. Navigate to the `ssi-handbook` folder.
9+
2. Open the specific section you want to edit, such as `organisational_chart.md`.
10+
3. Click the pencil icon in the upper-right corner (hovering over it will display "Edit this file").
11+
4. Modify the content as needed, ensuring you use proper Markdown formatting. For a Markdown guide, refer to [Markdown Guide](https://www.markdownguide.org/).
12+
5. Click on **Commit changes**.
13+
6. Enter a brief commit message summarizing your update, such as "Update organizational chart with new staff member." If needed, provide additional details in the 'Extended description' box.
14+
7. Verify that the option **Commit directly to the main branch** is selected.
15+
8. Click **Commit changes**. Your updates will appear in the handbook within a few minutes.

0 commit comments

Comments
 (0)