Details

Reviewers

Fabien
tobias_ruck

Group Reviewers

Restricted Project

Summary

This provides a full reference on how to use Chronik, from downloading, to building, to setup and how to use chronik-client.

This code is based on the auto-generated template tutorial for docusaurus.

It uses mdx, which is a mix of Markdown and JSX, which gives us the ability to include Live Code so the user can play around with the code examples right there.

Test Plan

in modules/chronik-client: npm install
in doc/chronik: npm install && npm start
Should open browser automatically, go through all pages and check if the information is correct

Diff Detail

Repository

rABC Bitcoin ABC

Branch

chronik-add-docusaurus-docs

Lint

Lint Passed

Unit

No Test Coverage

Build Status

Buildable 27763
Build 55087: Build Diff	chronik-client-integration-tests · chronik-client-tests
Build 55086: arc lint + arc unit

Event Timeline

tobias_ruck created this revision.Mar 8 2024, 20:09

Herald added a reviewer: Restricted Project. · View Herald TranscriptMar 8 2024, 20:09

tobias_ruck requested review of this revision.Mar 8 2024, 20:09

Harbormaster completed remote builds in B27757: Diff 46049.Mar 8 2024, 20:09

don't lint doc/chronik, it gives false positives

tobias_ruck edited the test plan for this revision. (Show Details)Mar 8 2024, 20:13

The build failed due to an unexpected infrastructure outage. The administrators have been notified to investigate. Sorry for the inconvenience.

remove copyright again, it break title detection

Harbormaster completed remote builds in B27758: Diff 46050.Mar 8 2024, 20:20

Harbormaster completed remote builds in B27759: Diff 46051.Mar 8 2024, 20:22

Fabien added inline comments.Mar 8 2024, 20:32

doc/chronik/package.json
3 ↗	(On Diff #46051)	It should have some version

fix social thumbnail tagline

Harbormaster completed remote builds in B27760: Diff 46052.Mar 8 2024, 20:43

Use meaningful component names in live demos

Harbormaster completed remote builds in B27761: Diff 46053.Mar 8 2024, 20:53

fix some typos

Harbormaster completed remote builds in B27762: Diff 46054.Mar 8 2024, 21:00

always refer to master branch in typedoc

Harbormaster completed remote builds in B27763: Diff 46055.Mar 8 2024, 21:36

The build failed due to an unexpected infrastructure outage. The administrators have been notified to investigate. Sorry for the inconvenience.

ws msgs not working due to buffer issue but that's on me to fix it in chronik-client. otherwise looks good. before landing,

favicon
decide on the url

then we can promote it without having to change all the links later

doc/chronik/docs/1-chronik-js/00-install.md
10	do we need `--save`? i use `npm i chronik-client`
doc/chronik/static/img/favicon.ico
1	can use same as e.cash for now, or even a very small version of the above chronik logo
doc/chronik/static/img/logo.svg
2	newline at end of file

This revision now requires changes to proceed.Mar 8 2024, 23:32

tobias_ruck added inline comments.Mar 8 2024, 23:37

doc/chronik/docs/1-chronik-js/00-install.md
10	I always use `--save`, `yarn` even has it as default
doc/chronik/static/img/logo.svg
2	sir this is a dinosaur
2	but yeah we can have that in the meantime

bytesofman mentioned this in D15667: [chronik-client] Build with webpack for browser support.Mar 9 2024, 00:01

bytesofman mentioned this in D15677: [chronik-client] Do not use buffer type to support browser builds without webpack Buffer fallbacks.Mar 11 2024, 19:26

bytesofman mentioned this in rABCa335b99d9d43: [chronik-client] Do not use buffer type to support browser builds without….Mar 11 2024, 23:49

superseded by D15767 and can be abandoned

bytesofman commandeered this revision.Mar 22 2024, 19:41

bytesofman abandoned this revision.

bytesofman edited reviewers, added: tobias_ruck; removed: bytesofman.

[Chronik] Add Docusaurus documentationAbandonedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 46055

.arclint

doc/chronik/.gitignore

doc/chronik/README.md

doc/chronik/babel.config.js

doc/chronik/docs/0-chronik-setup/00-download.mdx

doc/chronik/docs/0-chronik-setup/01-setup-chronik.md

doc/chronik/docs/0-chronik-setup/02-host-chronik.md

doc/chronik/docs/0-chronik-setup/03-congratulations.mdx

doc/chronik/docs/0-chronik-setup/03-congratulations.scss

doc/chronik/docs/0-chronik-setup/04-tune-chronik.md

doc/chronik/docs/0-chronik-setup/05-build-chronik.md

doc/chronik/docs/0-chronik-setup/_category_.json

doc/chronik/docs/1-chronik-js/.gitignore

doc/chronik/docs/1-chronik-js/00-install.md

doc/chronik/docs/1-chronik-js/01-connect.mdx

doc/chronik/docs/1-chronik-js/02-blockchain.mdx

doc/chronik/docs/1-chronik-js/03-blocks.mdx

doc/chronik/docs/1-chronik-js/04-txs.mdx

doc/chronik/docs/1-chronik-js/05-addresses.mdx

doc/chronik/docs/1-chronik-js/06-tokens.mdx

doc/chronik/docs/1-chronik-js/07-broadcast-tx.mdx

doc/chronik/docs/1-chronik-js/08-websocket.mdx

doc/chronik/docs/1-chronik-js/_category_.json

doc/chronik/docs/intro.md

doc/chronik/docusaurus.config.js

doc/chronik/package-lock.json

doc/chronik/package.json

doc/chronik/sidebars.js

doc/chronik/src/components/HomepageFeatures/index.js

doc/chronik/src/components/HomepageFeatures/styles.module.css

doc/chronik/src/css/custom.css

doc/chronik/src/pages/index.js

doc/chronik/src/pages/index.module.css

doc/chronik/src/theme/ReactLiveScope/index.tsx

doc/chronik/static/.nojekyll

doc/chronik/static/img/chronik-social-card.jpg

doc/chronik/static/img/docusaurus.png

doc/chronik/static/img/favicon.ico

doc/chronik/static/img/logo.svg

doc/chronik/static/img/undraw_docusaurus_mountain.svg

doc/chronik/static/img/undraw_docusaurus_react.svg

doc/chronik/static/img/undraw_docusaurus_tree.svg

modules/chronik-client/typedoc.json

[Chronik] Add Docusaurus documentation
AbandonedPublic
Actions

Revision Contents
Changeset List