This addition was created with the command npx @docusaurus/init@latest init per https://v2.docusaurus.io/docs/installation. It generates stub doc pages. This diff is intended to serve as a reference point for future customizations to developer docs for Cashtab extension, components, and bch-api.
Details
Details
- Reviewers
Fabien - Group Reviewers
Restricted Project - Commits
- rABC318e0b08c124: [Cashtab] Adding stub dev docs with facebook docusaurus
cd web/docs npm i npm start
Navigate to localhost:3000 if it does not open automatically in browser. Observe default docusaurus stubs.
Diff Detail
Diff Detail
- Repository
- rABC Bitcoin ABC
- Lint
Lint Not Applicable - Unit
Tests Not Applicable
Event Timeline
Comment Actions
- The test plan uses npm, but the doc uses yarn, and there is a yarn.lock file. Which one should I use ? Are both necessary ? Can we use the same package manager for our web projects to avoid adding dependencies ?
- I get the idea of setting up a template as an empty shell for building the docs, but I don't think it's a good idea to add all the docusaurus specific examples to our source tree, since they will all get deleted on next diff.
Comment Actions
Replacing yarn with npm, removing blog, replacing docusaurus stubs with cashtab stubs
| web/docs/.gitignore | ||
|---|---|---|
| 19 ↗ | (On Diff #27461) | remove |
| web/docs/README.md | ||
| 8 ↗ | (On Diff #27461) | switch to npm |
| web/docs/docusaurus.config.js | ||
| 9 ↗ | (On Diff #27461) | I don't think we are Facebook |
| 95 ↗ | (On Diff #27461) | This file deserves an update, it's still full of example content |
| web/docs/src/pages/index.js | ||
| 105 ↗ | (On Diff #27461) | Dito |
| web/docs/static/img/favicon.ico | ||
| 1 ↗ | (On Diff #27461) | there are icons under /share/pixmaps |