Skip to main content

Contributing to the Wiki

How to add and update content in the Veritect AI wiki.

Quick Start - For Everyone​

Method 1: Edit on GitHub (Easiest)​

  1. Navigate to any page on the wiki
  2. Click "Edit this page" at the bottom
  3. You'll be taken to GitHub
  4. Click the pencil icon to edit
  5. Make your changes
  6. Click "Commit changes"
  7. Add a description and submit

Method 2: GitHub Web Interface​

  1. Go to github.com/veritect-ai/wiki
  2. Navigate to docs/ folder
  3. Find your file or create new one
  4. Click pencil icon or "Create new file"
  5. Write in Markdown
  6. Preview your changes
  7. Commit with description

For Developers - Local Setup​

Prerequisites​

  • VS Code (recommended)
  • Node.js 18+
  • Git

Setup Steps​

# Clone the repository
git clone https://github.com/veritect-ai/wiki.git
cd wiki

# Install dependencies
npm install

# Start local development server
npm start

Your wiki will be available at http://localhost:3000

VS Code Extensions​

Install these for better experience:

  • Markdown All in One - Shortcuts and preview
  • Markdownlint - Style checking
  • Prettier - Auto-formatting

Writing Guidelines​

File Naming​

  • Use lowercase with hyphens: user-guide.md
  • No spaces in filenames
  • Descriptive names

Markdown Basics​

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

**Bold text**
*Italic text*
`inline code`

- Bullet point
- Another point
  - Nested point

1. Numbered list
2. Second item

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

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

```code block
with syntax highlighting

### Frontmatter

Every doc should start with:

```yaml
---
sidebar_position: 1
title: Page Title
description: Brief description
---

Adding Images​

  1. Save images to /static/img/
  2. Reference as: ![Alt text](/img/filename.png)
  3. Use descriptive filenames

Creating New Sections​

To add a new section:

  1. Create a folder in docs/
  2. Add _category_.json:
{
  "label": "Section Name",
  "position": 5,
  "link": {
    "type": "generated-index",
    "description": "Section description"
  }
}
  1. Add your .md files

Best Practices​

Do's ✅​

  • Write clear, concise content
  • Use headers for structure
  • Include examples
  • Add links to related pages
  • Update regularly

Don'ts ❌​

  • Don't commit sensitive information
  • Avoid large images (>1MB)
  • No personal credentials
  • Don't break existing links

Review Process​

  1. Self Review: Check preview before committing
  2. Peer Review: Tag a colleague for review
  3. Merge: Once approved, changes go live

Getting Help​

  • Slack: #wiki-help
  • Issues: GitHub Issues for bugs
  • Training: Monthly wiki training sessions

Quick Commands​

# See your changes
git status

# Stage changes
git add .

# Commit with message
git commit -m "Update user guide"

# Push to GitHub
git push

# Pull latest changes
git pull

Tips for Non-Technical Users​

  1. Use GitHub's web editor - No setup needed
  2. Copy existing pages as templates
  3. Ask for help - We're here to support you
  4. Start small - Edit existing content first
  5. Preview often - Check how it looks

Remember: You can't break anything! Git keeps all history, so we can always revert changes if needed.