Editing Documentation

This guide explains how to edit and create documentation on our internal documentation site.

Editing Existing Pages

Each page in our documentation has an "Edit this page" icon in the top right corner. Click this icon to edit the page directly on GitHub.

1. Click the pencil icon (✏️) at the top right of any page
2. Make your changes in the GitHub editor
3. At the bottom of the page, add a commit message describing your changes
4. Click "Commit changes"
5. Your changes will be reviewed and published automatically after approval

Creating New Pages

To create a new page:

1. Go to the GitHub repository
2. Navigate to the docs folder and the appropriate section
3. Click "Add file" > "Create new file"
4. Name your file with a .md extension (e.g., my-new-guide.md)
5. You can copy our page template as a starting point
6. When finished, commit your changes as described above

Markdown Basics

Our documentation uses Markdown for formatting. Here are some basics:

# Heading 1
## Heading 2
### Heading 3

**Bold text**
*Italic text*

- Bullet point
- Another bullet point

1. Numbered item
2. Another numbered item

[Link text](https://example.com)

![Image alt text](path/to/image.png)

`inline code`

```python
# Code block with syntax highlighting
def function():
    return True

Advanced Features

Our documentation system supports several advanced features:

Admonitions (Notes, Warnings, etc.)

!!! note "Optional Title"
    This is a note admonition.

!!! warning
    This is a warning admonition.

!!! tip
    This is a tip admonition.

Task Lists

- [x] Completed task
- [ ] Incomplete task

Tabs

=== "Tab 1"
    Content for tab 1

=== "Tab 2"
    Content for tab 2

Need Help?

If you need assistance with editing documentation, please contact the documentation team or open an issue on the GitHub repository.