iota-wiki
iota-wiki copied to clipboard
Simplify external documentation
TL;DR: Let's maintain dependencies in the Wiki root, move the CLI to the Wiki repo and use npx or yarn dlx to run a local development server in external documentation.
We have the need to add the same external documentation to multiple environments, for example, environment-agnostic documentation and library documentation that has versions compatible with multiple environments. We also wanted external documentation to be able to provide its own dependencies, so we configured them to be their own NodeJS packages which we included in our build using Yarn workspaces.
Yarn, however, doesn't allow duplicate workspaces in a worktree. Also, external documentation does not seem to need any other functionality than we provide out of the box already, or could easily add as root dependency when necessary, removing the need for external documentation to be their own packages.
TODO:
- [ ] Remove workspaces and install any missing dependencies in the Wiki root package.
- [ ] Move the CLI to the Wiki repo and let it use the Next environment configuration.
- [ ] Publish the CLI to NPM.
- [ ] Remove
package.jsonand addnpxcommand to README in the external documentation repos:- [ ] bee
- [ ] blueprints
- [ ] chronicle.rs
- [ ] cli-wallet
- [ ] goshimmer
- [ ] hornet
- [ ] identity.rs
- [ ] integration-services
- [ ] introduction-docs
- [ ] inx-chronicle
- [ ] inx-coordinator
- [ ] inx-dashboard
- [ ] inx-faucet
- [ ] inx-indexer
- [ ] inx-mqtt
- [ ] inx-participation
- [ ] inx-poi
- [ ] inx-spammer
- [ ] IOTA-2.0-Research-Specifications
- [ ] iota.js
- [ ] iota.rs
- [ ] streams
- [ ] stronghold.rs
- [ ] wallet.rs
- [ ] wasp
- [ ] Zebra-Iota-Edge-SDK