Skip to content

Latest commit

 

History

History
40 lines (23 loc) · 1.63 KB

README.md

File metadata and controls

40 lines (23 loc) · 1.63 KB
Raw

Genie Framework documentation

This site hosts the docs for all the packages in the Genie Framework.

Running locally

To run the site locally, execute

npm install
npm run dev

Deploying to production

On each commit to main, the site will be automatically deployed to learn.genieframework.com. When a pull request is created, a new preview site will be automatically linked in the comments.

Adding content

To add a new page, write its content into the content/ folder in the relevant path.

API docs

The API docs each package's API section are built in this repo

Code examples

The content in the Code Examples page is built in this repo.

Contributing

If you would like to contribute with a new article or fix mistakes, please open an issue with your suggested changes or open a new pull request. The team will review the text and make or request any necessary changes to make it fit better with the rest of the documentation.

It is recommended that you ask first, either in an issue or on Discord, before contributing new materials to make sure they are a good fit. Here are some writing guidelines:

  • Be clear and concise: avoid jargon and complex sentences. Assume the reader is new to the topic.
  • Consistent terminology: use consistent terms for the same concept throughout the documentation.
  • Active voice: use the active voice as much as possible, e.g., "You can configure settings" rather than "Settings can be configured."
  • Linking: provide links to relevant articles, guides, or documentation pages for further reading.