Skip to content

Commit

Permalink
Add information about categories and patch changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ChampionAsh5357 committed Oct 2, 2023
1 parent 3df4069 commit 15cdee9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions src/pages/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,10 @@ public float applyDiscount(float price) {

If the pseudocode is not explanatory enough to understand the concept, then a full code example can be used instead. A full code example should supply dummy values and explain what they represent.

## Minor and Patch Changes

If a change occurs between a minor or patch versions of NeoForge, then relevant changes in the documentation should be split into separate sections or put into tabs. This maintains the accuracy of the information depending on the version the modder is currently developing for.

## Style Guide

This documentation uses [Docusaurus][docusaurus], which internally uses [MDX][mdx], to generate the pages. You can find more detailed information about available features on their pages. This style guide will be more focused towards common features and formatting we use in the Markdown files.
Expand All @@ -70,6 +74,20 @@ sidebar_position: 2
---
```

#### Categories

Categories are folders within the documentation. They inherit titles and positional data from `index.md`. If an `index.md` is not within a subfolder, a `_category_.json` file should be created, specifying the `label` representing the name of the section, and `position` representing where on the sidebar it should go.

```js
{
// Name of the category to display
"label": "Example Title",

// This will be rendered as the third element on the sidebar at the current level.
"position": 3
}
```

### Titles

Titles are defined using up to six hashtags (`#`) to define each section. Titles should capitalize everything but unimportant words.
Expand Down

1 comment on commit 15cdee9

@neoforged-pages-deployments
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deploying with Cloudflare Pages

Name Result
Last commit: 15cdee9cecf404a8cc308c5eb0248fa4f95c04b8
Status: ✅ Deploy successful!
Preview URL: https://b80c87e0.neoforged-docs-previews.pages.dev
PR Preview URL: https://pr-14.neoforged-docs-previews.pages.dev

Please sign in to comment.