This website is built using Docusaurus 2, a modern static website generator.
Install protoc. Below is how you would install on macOS
brew install protobufInstall protoc-gen-doc. This depends on golang.
go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latestnpm install
git submodule update --init --recursiveCopy the example local configuration for use in development.
cp .env.local.example .env.localnpm run startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
npm run buildnpm run serveThis command generates static content into the build directory and can be
served using any static contents hosting service.
The coding style rules are defined by Prettier and enforced by Eslint
For VSCode you can enable format on save within the Prettier VSCode extension.
Ensure that any files you edited are formatted with Prettier's default formating.
We use ESlink for static code analysis.
We use pre-commit to automatically setup and run git hooks.
On every git commit we check the code quality using Prettier and ESlint.
Prefer markdown links that link to files including the file extension
(e.g. [Filter](./docs/database/database.md)) over absolute links.
Also, be mindful that the Tigris docs Docusaurus has trailingSlash
set to true so links are always from a directory.
└── database
├── architecture.md
└── filters.md
In the above scenario, a link from /docs/database/filters to
/docs/database/architecture would need to be ../architecture when not
linking using a file extension. This is another reason why it is better
and simpler to have links that include a file extension
(e.g. this in the above case the link is simply architecture.md).
tigris-api is included as a submodule. After updating the submodule to pull in new proto changes, the documentation can be updated using the following steps:
npm run generate
Move Services section before Messages section in protodocs/server/v1/api.proto.mdx