Quick Start for Content Authors

Time to read: 5 minutes

This guide helps you add or edit content in the EBRAINS Handbook - no technical expertise required.

Two Ways to Contribute

Option 1: Edit Online (Easiest - No Setup Required)

Best for: Quick edits, fixing typos, updating existing pages

1. Go to the EBRAINS Handbook Docs Repository
2. Navigate to the file you want to edit
3. Click Edit → Open in Web IDE
4. Make your changes
5. Click Source Control → Commit to new branch
6. Create a merge request

That’s it! Someone will review and merge your changes.

Option 2: Work Locally (For Bigger Changes)

Best for: Adding multiple pages, working offline, previewing changes

Where to Add Your Content

Your content lives in simple folders at the root of the repository:

No deep nesting! Just go to the section folder and add your page.

Creating Content: Copy & Paste Templates

Template 1: Simple Page

Copy this template, save as my-page-name.md in any section folder:

Template 2: Section Landing Page

To create a new section (like “My Team Documentation”), create a folder with _index.md:

Folder structure:

File content (_index.md):

Template 3: Section with Multiple Pages

Folder structure:

Pages appear in sidebar order based on their weight value (lowest first).

Understanding the Frontmatter

The stuff between --- at the top of each file:

That’s all you need! Don’t worry about the other fields for now. You can find more details here

Quick Tips

✅ Do This

• Use simple file names: getting-started.md, user-guide.md
• Add descriptive titles in frontmatter
• Use weights to control order (10, 20, 30…)
• Write in plain Markdown

❌ Avoid This

• Don’t use spaces in file names: my file.md → my-file.md
• Don’t skip the frontmatter
• Don’t commit directly to main branch
• Don’t worry about perfect formatting—reviewers will help!

Next Steps

• Need formatting help? See Markdown Guide
• Complex contribution? See Working Locally
• Can’t figure it out? Write in any format and someone will help!