Page MenuHomePhabricator

[Cashtab] Adding stub dev docs with facebook docusaurus
ClosedPublic

Authored by josephroyking on Jan 27 2021, 19:21.

Details

Reviewers
Fabien
Group Reviewers
Restricted Project
Commits
rABC318e0b08c124: [Cashtab] Adding stub dev docs with facebook docusaurus
Summary

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.

Test Plan
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

Repository
rABC Bitcoin ABC
Lint
Lint Not Applicable
Unit
Tests Not Applicable

Event Timeline

Fabien requested changes to this revision.Jan 28 2021, 08:10
Fabien added a subscriber: Fabien.
  1. 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 ?
  2. 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.
This revision now requires changes to proceed.Jan 28 2021, 08:10

Replacing yarn with npm, removing blog, replacing docusaurus stubs with cashtab stubs

Fabien requested changes to this revision.Feb 1 2021, 20:34
Fabien added inline comments.
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

This revision now requires changes to proceed.Feb 1 2021, 20:34

Replace docusaurus stub settings and copy, add extension stub page

This revision is now accepted and ready to land.Feb 2 2021, 08:35