Oqtane Documentation

Tip

Help us improve the docs! Here you'll learn how.

Setup and Instructions

Oqtane documentation is written in Markdown and hosted on GitHub. The docs are built using DocFX, a static site generator for API documentation. This is a very common setup for .NET projects, and it's easy to get started.

We've worked hard to make sure that these docs are built using best-practices similar to other .net projects, and our template for this is 2sxc (the CMS plugin for Oqtane).

Tip

Since the docs use the same setup and conventions as the 2sxc docs, we can also leverage their instructions for maintaining the docs.

➡️ To learn how to improve the Oqtane Docs, visit the Docs-Docs.

Docs Team

The docs team is responsible for the documentation of Oqtane. It currently consists of:

• @iJungleboy (Team Lead)
• @thebaum
• @GregStevenson
• YOU - we want you 🫵🏽!

Top Level View

Things to consider for the docs project

• Content: breadth, depth and quality of docs
• Maintenance / Timeliness: keep docs up to date with features & changes
• Use: get people to find use the docs
• Contribute: get people to contribute

Content

This covers a lot of areas:

1. Content Breadth, Depth and Quality
2. Code Documentation - volume and quality
   These are the XML comments in the source code which are maintained in the main repo
3. Backgrounds / Concepts
   These are the "What is Oqtane" and "What is a Module" type of docs which both help understand something, and often serve as background for other docs. Without these backgrounds, pages will tend to repeat the same information since there's no primary link.
4. User Help (what does this dialog / button do)
5. Guides / How-To
6. Link other resources

Maintenance

Things we should consider for maintenance

1. new features
2. changes in Oqtane which result in
   1. different UIs
   2. different ways to do things as a user
   3. different ways to develop something

Use

Bring people to docs eg. move "Getting Started" from Github to docs and link from Github/Oqtane

Contribute

Questions

1. what motivates people to contribute to docs?
2. how can we make it easy to contribute?
3. can we provide benefits or visibility to contributors?

---

Main Author

Daniel Mettler, @iJungleboy [MS MVP, Oqtane Core Team]

Content Management Expert, Chief Architect of 2sxc and cre8magic.
Forged in the jungles of Indonesia, lives in Switzerland , loves Oqtane 🩸 & 2sxc 💜.

LinkedIn | Discord: @iJungleboy | Twitter: @iJungleboy | Github: @iJungleboy