This documentation or site is built with VitePress, and some of its features are borrowed from vue/docs.
For local development, pnpm is preferred as package manager:
pnpm i
pnpm run docs:devThis project requires Node.js to be v14.0.0 or higher, because we use new JavaScript features in our code, such as optional chaining.
Like many projects, commits should conform to the following format.
doc: [changes]
As an example, when you are making additions or changes to the API documentation, the format should look like following format.
doc: [add/update/improve] [API name] api documentation
doc: add object api documentation
doc: update optics api documentation