Skip to main content

Contributors Guide

✏️ How to Edit​

  1. Locate File: Find the corresponding .md file in the mimshack-wiki/docs directory.
  2. Modify: Edit the markdown content using your favorite code editor (e.g., VS Code).
  3. Preview: Run npm start in the mimshack-wiki directory to see your changes locally.
  4. Commit: Stage and commit your changes to the Git repository.
  5. Deploy: Push your changes to the main branch to trigger a rebuild/deployment.

🎨 Style Guide​

  • Headings: Use # for H1 (Page Title), ## for H2 (Sections).
  • Frontmatter: Ensure every page has title and description in the YAML frontmatter.
  • Tone: Professional, Concise, Active Voice.
  • Formatting: Use Bold for emphasis, not CAPS.

📂 Creating New Pages​

  • Add a new .md file in the appropriate subfolder in docs/.
  • Update sidebars.ts to include the new page in the navigation menu.
  • Use the Path convention: category/page-name (e.g., subsidiaries/mimshack-farms).