mirror of
https://github.com/oreonhq/wiki.git
synced 2026-11-19 20:29:13 -08:00
Oreon Community Wiki
- JavaScript 82.7%
- CSS 17.3%
|
|
||
|---|---|---|
| .github | ||
| docs | ||
| src | ||
| static | ||
| .gitignore | ||
| docusaurus.config.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| sidebars.js | ||
Oreon Wiki
This is the community-driven wiki for the Oreon HQ, built using Docusaurus.
Writing Documentation
Folder Structure
All documentation pages should be placed in the appropriate subfolder within docs/:
docs/Basics/- Fundamental concepts, installation guides, and getting started informationdocs/Guides/- Step-by-step tutorials, how-to guides, and practical examplesdocs/Information/- Reference materials, API documentation, and detailed technical information
Creating New Pages
- Create a new
.mdor.mdxfile in the appropriate folder - Add frontmatter at the top of your file:
--- sidebar_position: 1 title: "Your Page Title" --- - Write your content using standard Markdown
- The page will automatically appear in the sidebar
Markdown Guidelines
- Use clear, descriptive headings with
#,##,###etc. - Include code examples in proper code blocks with syntax highlighting
- Use relative links to other wiki pages:
[Link Text](../other-page) - Link to external resources when helpful
- Keep content organized with proper heading hierarchy
Contributing Guidelines
- Fork the repository
- Create a new branch for your changes
- Add or edit documentation in the appropriate
docs/subfolder - Test your changes locally (see Development section below)
- Submit a pull request with a clear description of your changes
Content Standards
- Write for your audience - assume basic familiarity with development concepts
- Provide working code examples when possible
- Include troubleshooting sections for common issues
- Keep content up-to-date with current Oreon versions
- Cross-reference the official documentation when appropriate
Development
Installation
npm install
Local Development
npm start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
Build
npm build
This command generates static content into the build directory and can be served using any static contents hosting service.
Deployment
Using SSH:
USE_SSH=true npm deploy
Not using SSH:
GIT_USER=<Your GitHub username> npm deploy
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.
Project Structure
docs/
├── basics/ # Fundamental concepts and getting started
├── guides/ # Tutorials and how-to guides
├── information/ # Reference and technical documentation
└── intro.md # Wiki homepage
src/
├── css/ # Custom styling
└── pages/ # Custom pages (auto-redirects to docs)
static/
└── img/ # Images and assets