This website is built using Docusaurus 2, a modern static website generator.
$ yarn
$ yarn start
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
$ yarn build
This command generates static content into the build directory and can be served using any static contents hosting service.
NEAR Treasury uses a style guide for our documentation so that we can make it as easy to understand as possible. The Style Guide is a concise style reference for our documentation, but it isn't comprehensive. For anything not found in our style guide, use Google's Developer Docs Style Guide.
Making our documentation easy to understand includes optimizing it for client-side machine translation into other languages. To help with this, please see the following technical writing style tips:
- Generally, use the second person ("you") rather than the third-person ("the developer") when addressing the reader.
- Always use the third person when describing NEAR Treasury or features (avoid "this lets us" in favor of "this lets NEAR Treasury").
- Write in present-tense, active voice when you can.
- Prefer simple sentences to complex and complex-compound sentences.
Note: Please don't let these style conventions stop you from creating a PR to share your contribution to NEAR Treasury Docs! 🙏