How to Add Documentation to CRED Wiki

This guide shows team members how to add new documentation to this CRED Wiki project.

Quick Steps

1. Create a New File

Create a new .md file in the docs/ folder:

# Example: Create a new page
touch docs/your-page-name.md

2. Write Your Content

Use Markdown to write your documentation:

# Your Page Title

Your content goes here.

## Section 1

Content for section 1.

## Section 2

Content for section 2.

Edit mkdocs.yml and add your page to the navigation:

nav:
    - Home: index.md
    - Getting Started: getting-started.md
    - Your New Page: your-page-name.md # Add this line
    - CRED Comercial: cred-comercial.md
    - CRED Model: cred-model.md
    - CRED Agent: cred-agent.md
    - API: api-overview.md
    - About: about.md

4. Preview Your Changes

Run the development server:

mkdocs serve

Visit http://127.0.0.1:8000 to see your changes.

Common Markdown Examples

Headers

# Main Title

## Section Title

### Subsection Title

Text Formatting

**Bold text**
_Italic text_
`Code text`

Lists

-   Item 1
-   Item 2
-   Item 3

1. First item
2. Second item
3. Third item

Code Blocks

```bash
# Command example
npm install
```

```python
# Python example
def hello():
    print("Hello CRED!")
```

Links

[Link to another page](page-name.md)
[External link](https://example.com)

Images

![Alt text](assets/image-name.png)

File Organization

Where to Put Files

Main pages: docs/your-page.md
Project pages: docs/project-name.md
Images: docs/assets/image-name.png
Sub-pages: docs/project/sub-page.md

File Naming

Use lowercase letters
Use hyphens instead of spaces: user-guide.md
Be descriptive: api-authentication.md

Adding Content to Existing Projects

CRED Agent

Edit docs/cred-agent.md to add agent system documentation.

CRED Comercial

Edit docs/cred-comercial.md to add commercial platform documentation.

CRED Model

Edit docs/cred-model.md to add AI model documentation.

Tips

Keep content clear and simple
Use headings to organize information
Include code examples when helpful
Test your changes with mkdocs serve
Ask the team if you need help

Need Help?

Check existing pages for examples
Ask the development team
The wiki updates automatically when you save files

Ready to add your first page? Start with step 1 above!