https://github.com/genieframework/genieframeworkdocs
Documentation site for the Genie Framework
https://github.com/genieframework/genieframeworkdocs
Last synced: 4 months ago
JSON representation
Documentation site for the Genie Framework
- Host: GitHub
- URL: https://github.com/genieframework/genieframeworkdocs
- Owner: GenieFramework
- Created: 2023-07-13T10:04:57.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T10:33:57.000Z (over 1 year ago)
- Last Synced: 2025-06-05T04:25:58.516Z (about 1 year ago)
- Language: Vue
- Homepage: https://learn.genieframework.com
- Size: 95 MB
- Stars: 4
- Watchers: 5
- Forks: 23
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Genie Framework documentation
This site hosts the docs for all the packages in the Genie Framework.
# Running locally
To run the site locally, execute
```bash
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](https://github.com/GenieFramework/APIDocs)
# Code examples
The content in the Code Examples page is built in [this repo](https://github.com/BuiltWithGenie/CodeExamples).
# 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.