Contributing to this Documentation
This documentation was built with Nextra .
Understanding Documentation Structure
This is the minimum required to get started writing documentation for Nexus. For full details including markup syntax, see their documentation to make boxes such as this.
This documentation includes two main directories: app and content.
App Directory
The app directory contains configuration and routing logic for the documentation content directory. It includes [[...mdxPath]], which is responsible for dynamically routing the content MDX files.
You will rarely need to modify app, if ever. This structure is simply intended to help you understand the content directory.
Content Directory
The content directory contains the actual documentation files, organized in a way that makes it simple. This is where you will create, update, and delete documentation.
Each subdirectory, or subfolder, represents a documentation section, denoted on the sidebar, e.g. Users, Developers, Documentation, About are all folders. Each Markdown or MDX file in a subdirectory then represents a page in your documentation site. The initial How it works section at the start of the documentation is different than its named folder which we’ll see in the next section.
The terms folder and directory may be used interchangeably.
URL Path Naming
The app will append every nested folder name to the URL until eventually appending the content file name. You may choose folder and file names based on what you would like the URL to appear as.
For example, if you have a folder called overview and a file called getting-started.mdx, the URL will appear as example.com/docs/overview/getting-started. As such, everything should follow a URL naming scheme, lowercase and hyphenated.