Thank you for looking into contributing to Nile documentation.
If you haven't yet reviewed our developer guide, it is worth taking a look. If you are in a hurry, the gist is:
- If you see something wrong, confusing or missing, please help us by reporting an issue. We love feedback.
- We accept pull requests from forks of this repository
- Pull request description should explain their intent
- We are keeping the community friendly. Take a look at our code of conduct for details.
Turborepo is used to manage and run this monorepo.
-
Install the dependencies in the root of the repo
npm install
-
Built the website and docs initially:
npm run build:www
-
Run the website and docs locally:
npm run dev:www
-
Now you can make any change, fix or improvement you'd like and see the result locally.
-
See docs for more details about adding/revising documentation
-
See templates for more details about adding/revising templates
If you are stuck, need help, or wondering if a certain contribution will be welcome, please ask! Either in our Discord or Github discussions
Looking forward to reviewing your contributions.