Closed jlvandenhout closed 1 year ago
For reference: npx
or yarn dlx
won't work, because we need Docusaurus to be installed locally, so a package.json
is necessary anyway.
@Dr-Electron I guess this can be closed? We only have the TIPs repo as submodule, but I think we should handle any changes to that approach in separate issues.
Yes
TL;DR: Let's maintain dependencies in the Wiki root, move the CLI to the Wiki repo and use
npx
oryarn 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:
package.json
and addnpx
command to README in the external documentation repos:~package.json
to have"@iota-wiki/cli": "latest"
indevDependency
and removeyarn.lock
: