Table of Contents
Tip

The docs as explained here are used in multiple projects, but documented only once for better maintenance. When applying this to other projects, remember that some things such as the name, repository, or paths are a bit different.

Contribute to Documentation

First of all: Thank you 🙏🏽 for considering to contribute to the documentation 🎉. We really appreciate it.

These are the things you can do, in order of complexity. You should really start with the first one, and only move on if you're comfortable with it.

  1. Just get the docs and view locally
  2. Improve existing content
  3. Add new content, link around and add tables of Contents
  4. Create/improve docs to the C# source-code
  5. Create/improve docs to the JavaScript source-code
  6. Create/improve the build process

Level 1: Get the Docs and View Locally

  1. Download the docs to your PC and figure out the VS-Code setup, so you can work locally and preview the result.
    ➡️ Setup & Preview Docs Locally using VS-Code

  2. Run the docs-build to see if everything works.
    ➡️ Build the Documentation

Level 2: Improve Existing Content

Content is written using Markdown. This is a common format used for Wikipedia, GitHub and many other places.

  1. Enable the preview in VS-Code to see your changes live.
    ➡️ Enable Preview in VS-Code
  2. Remember to re-run the docs-build to see if everything works.
    ➡️ Build the Documentation

Once you've grown comfortable with Basic Markdown, you can also learn about Images, Lightboxes and then move on to Galleries, flowcharts and more.

Level 3: Create New Pages and TOCs

After graduating from Level 2, you can start creating new content and linking it together. This includes things like:

  1. Create new markdown pages *.md
  2. Link to them from other pages
  3. Create and modify tables of Contents
  4. Learn about Permalinks (UIDs) to ensure links don't break

Level 4: Docs to C# Source-Code

Here things can get a bit more challenging, which is why we saved this for Level 4. Basically we'll use the XML-comments in the C# code to generate documentation.

  1. Read about documenting source code and namespaces

  2. Then Build Docs and Code.

  3. As you get better, we suggest reading the Technical Implementation of the Docs to understand how everything works.

Level 5 & 6

...not explained in detail, but you'll find everything you need in the TOC to the left.

CC-BY All docs are licensed as CC-BY. By contributing you agree that your work can be used in this way.

Questions

For further discussions, feedback, or questions, head over to GitHub Discussions or GitHub Issues.

Edit this page