This website is built using Docusaurus 3, a modern static website generator. It is the official Technical Documentation Website of LUKSO.
Live URL: https://docs.lukso.tech/
When the docs pages are built, documentation of the following repositories will be pulled in from the respective repos and updated automatically:
NOTE: Make sure to edit these tools in their respective repos, otherwise changes in the docs here will be overwritten.
yarn installyarn startThis command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
yarn buildyarn upgrade-interactiveThis command generates static content into the build directory and can be served using any static contents hosting service.
- Run
docs:tools:syncto pull documentation from tool repositories (erc725.js).
npm run docs:tools:sync- Commit and push generated changes
The contract ABI docs located under the docs/contracts/contracts folder are originally stored and updated in the lsp-smart-contracts Github repository, under the docs/ folder.
The CI in contracts-sync.yml runs every day at midnight to pull automatically any new changes from these files in the repo (from the main branch).
Any new release of the package will open a PR automatically in the repo to fetch the new docs changes.
You can also fetch the new contract ABI docs manually as follow:
- Run
docs:contracts:syncto pull documentation from the (lsp-smart-contracts).
npm run docs:contracts:sync- Commit and push generated changes