Authoring Guide · Getting Started
Getting Started
Quick start guide and basic concepts for your portfolio website
Getting Started
This section will help you get started quickly. If you do not have a repo yet, start with Create a knowledge base (CLI). Then learn the content layout and Author Studio.
Understanding the Structure
Your portfolio website uses a hierarchical structure for documentation:
- Sections (top level) - Major categories like "Guide", "Knowledge Base"
- Subsections (second level) - Categories within sections like "Getting Started", "Features"
- Documents (individual pages) - The actual content files
File Structure
All content is stored in the content/ directory:
Basic Concepts
Frontmatter
Every content file needs frontmatter at the top:
URL Structure
The URL matches your folder structure:
content/docs/Authoring-guide/overview.mdx→/docs/Authoring-guide/overviewcontent/docs/Authoring-guide/getting-started/overview.mdx→/docs/Authoring-guide/getting-started/overviewcontent/blog/my-post.mdx→/blog/my-post
Overview Pages
Major sections can have overview pages that describe what the section contains. When an overview page exists, the section title becomes clickable in the sidebar.
Next Steps
- Create a knowledge base (CLI) - Bootstrap a new site
- Versions and upgrades - How 1.2 stays safe when 2.0 ships
- Understanding Documentation Structure - Learn about sections and subsections
- Creating Your First Document - Create your first documentation page
- Understanding Features - Learn about all available features
- Troubleshooting - Common issues and solutions