📖 Documentation

Contribution Guide

We welcome contributions from the community! Whether you're fixing bugs, adding features, or improving documentation, your help makes Cortex HQ better for everyone.

Code of Conduct

We are committed to fostering a respectful, inclusive, and welcoming community. Harassment, toxic behavior, or discrimination of any kind will not be tolerated. All contributors are expected to treat others with kindness and professionalism.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally
  3. Run npm install to install dependencies
  4. Run npm run dev to start the development server

Project Structure

cortexhq.net/ ├── pages/        # Next.js pages ├── components/   # Reusable components ├── styles/       # Global CSS └── package.json

Making Changes

  • Create a feature branch from main
  • Keep commits clear and descriptive
  • Test your changes locally before pushing
  • Keep pull requests focused on a single concern

Pull Request Process

  1. Ensure your code builds with npm run build
  2. Update documentation if your changes introduce new behaviour
  3. Submit a pull request with a clear title and description
  4. A maintainer will review your PR and may request changes
  5. Once approved, your PR will be merged

Development Tips

  • npm run dev — hot-reload for rapid iteration
  • npm run build — production build to verify everything compiles
  • This project uses Next.js Pages Router
  • Styles are written with styled-jsx (scoped to each component)

Need Help?

Join our Discord support server and a maintainer will be happy to assist you.