Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.87 KB

README.md

File metadata and controls

57 lines (36 loc) · 1.87 KB
Raw

Imanity Documentation

A documentation website for Imanity projects.

Visit:

https://docs.imanity.dev/.

To run docs locally:

  1. Clone this repo
  2. Run yarn or npm install
  3. Run yarn start or npm start

Deployment is done through by pushing the code to the main branch.

Built With

The Imanity Documentation is built using Docusaurus v2.

Contributing

Imanity Documentation uses Conventional Commits.

Scope format example for editing pages: category/sub-category or page (e.g. ispigot/api)

We will review all issues and pull requests posted to this repository. If you notice any mistakes, or feel something is missing, feel free to create an issue to discuss with the team or directly create a pull request with suggestions. Here is a basic workflow to open a pull request:

Edit existed pages

It will be easier for you to open the page you want to edit:

  1. Scroll down to the bottom of the page you want to edit and click Edit this page.
  2. Click Fork this repository
  3. Make your changes.
  4. Open a pull request to the develop branch of this repository.

Forking

  1. Fork this repository to your own account and clone it (git clone https://github.com/Imanity-Software/documentation.git)
  2. Remember to change your git remote value
  3. Create a feature branch for your changes (git checkout -b feat/amazing-feature).
  4. Make your changes.
  5. Commit your changes (git commit -m 'Add some amazing feature').
  6. Push your changes to your fork (git push origin feat/amazing-feature).
  7. Open a pull request to the develop branch of this repository.

Have a look at CONTRIBUTING for further guidance.

License

Imanity Docs is MIT licensed.

The Imanity documentation (e.g., .md files in the /docs folder) is Creative Commons licensed.