This repository contains the source files for the SampSharp documentation. The site is built with DocFX, a powerful documentation generator designed for .NET projects.

For Documentation Contributors Only

This guide is intended for people contributing to the SampSharp documentation. If you're looking for SampSharp documentation, visit sampsharp.net.

• .NET 10 SDK or later

1. Install DocFX (one-time setup):

   dotnet tool install -g docfx

2. Build the SampSharp component:

   cd sampsharp-src && ./build.sh component

3. Start the development server:

   docfx --serve

   The site will be available at http://localhost:8080/

All documentation is written in Markdown in the docs/ folder. For Markdown syntax reference, see the DocFX Markdown Documentation.

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

   • docs/core-concepts/ - ECS concepts and architecture fundamentals
   • docs/features/ - Feature-specific guides
   • docs/reference/ - Reference material
   • docs/support/ - Support content (troubleshooting, migration guides)

2. Add a YAML frontmatter header to the file:

   ---
   title: Your Page Title
   uid: unique-identifier
   ---

3. Add the file reference to the corresponding toc.yml:

   - href: your-page.md

docs/
├── index.md                    # Home page (redirects to quick-start)
├── quick-start.md              # Quick Start guide
├── getting-started.md          # Redirect stub for legacy URL
├── core-concepts/              # ECS pages (linked directly from root TOC)
│   ├── index.md                # Entity-Component-System overview
│   └── ...
├── features/                  # Feature pages (linked directly from root TOC)
│   └── ...
├── reference/
│   ├── toc.yml                 # Reference table of contents
│   └── ...
├── support/
│   ├── toc.yml                 # Support table of contents
│   └── ...
├── legacy/                     # Legacy/deprecated content
│   ├── toc.yml
│   └── ...
└── toc.yml                     # Main table of contents

• Internal links: Use relative paths with .md extension: [link text](systems.md) or [link text](../guides/systems.md)
• External links: Use full URLs: [link text](https://example.com)
• Cross-references: Link to other documentation pages using <xref:uid> (where uid is the page's uid field from frontmatter): <xref:systems>
• Note blocks: Use > [!NOTE] syntax for important callouts
• Tabs: Use DocFX tab syntax for tabbed content (see DocFX Markdown Documentation)
• Code references: Use <xref:NameSpace.ClassName> to create cross-references to API documentation

• DocFX Documentation
• DocFX Markdown Guide
• SampSharp Project