Skip to content

Repository files navigation

Official Documentation - opiasec

Welcome to the official documentation repository for our community! This space is dedicated to providing clear guides, tutorials, roadmaps and all the necessary information so you can make the most of opiasec.

🚀 Accessing the Documentation

You can access the published version of our documentation at opiasec docs. This repository contains all the source code and content used to build our documentation site with Docusaurus.

🔗 Important Links

Report a Platform Issue: If you found a bug in the platform (not in the documentation), please open an issue in the main repository.

✏️ How to Contribute

Contributions to our documentation are always welcome! Whether fixing a typo, improving an explanation, translating content, or writing a new guide, your help is valuable.

  • Read our Contributing Guide: Before starting, please read our CONTRIBUTING guide to understand the process, standards, and how to set up the environment.
  • Find something to do: Take a look at our issues, especially those marked as documentation or good first issue. Fork and create a Pull Request!

Running the Project Locally

To preview your changes while editing, you can run the documentation site locally.

1. Clone the repository

$ git clone https://github.com/opiasec/documentation.git $ cd documentation

2. Install dependencies

$ npm install

3. Start the development server

$ npm start

After running npm start, the site will be available at http://localhost:3000. Thank you for helping us build high-quality documentation for the opiasec community!

About

General documentation about opiasec organization and projects

Resources

Code of conduct

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages