Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add QGB docs #668

Merged
merged 18 commits into from
Apr 28, 2023
Merged

Add QGB docs #668

merged 18 commits into from
Apr 28, 2023

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Apr 18, 2023 •
edited
Loading

Overview

  • add intro from Add initial QGB Docs #279
  • update go version in README.md docs: bump go version in README.md orchestrator-relayer#312
  • change title of Relayer to IBC Relayer
  • set up automation to pull in outside markdown
    • the current set up uses a react component to render the markdown, this may not be the best way, because headings do not have anchor links
  • add Validators category
  • add Validator node, QGB orchestrator, and QGB keys subcommand to Validators category
  • change validator section to this (the trick here is there is no native support in docusaurus for nested items, only category > category > category, which would be messy):
  • Validators
    • Validator node
      • QGB Orchestrator
        • Keys subcommand
  • change the Celestiums category to:
  • Celestiums (QGB)
    • QGB Relayer
      • Deploy the QGB contract
  • add Celestiums (QGB) category
  • add QGB Relayer and Deploy the QGB contract pages to Celestiums (QGB) category
  • make PRs to resolve issues with table formatting on source markdown
  • fix linting and standardize titles docs: standardize titles for celestia docs & fix linting orchestrator-relayer#295 after we decide on structure. I am leaning toward V1 but V2 also works

Final version of menu

scrot 2023-04-28 at 11 54 35 AM

Draft menu previews

V3 (I think this looks messy)

scrot 2023-04-18 at 6 27 39 PM

V2 (current in preview)

scrot 2023-04-18 at 10 16 20 PM

V1

scrot 2023-04-18 at 5 41 10 PM

Checklist

  • New and updated code has appropriate documentation
  • New and updated code has new and/or updated testing
  • Required CI checks are passing
  • Visual proof for any user facing features like CLI or documentation updates
  • Linked issues closed with keywords

@github-actions
Copy link
Contributor

github-actions bot commented Apr 18, 2023 •
edited
Loading

PR Preview Action 6da47fb
Preview removed because the pull request was closed.
2023-04-28 20:58 UTC

@jcstein jcstein self-assigned this Apr 18, 2023
@jcstein jcstein added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 18, 2023
@jcstein jcstein mentioned this pull request Apr 18, 2023
Merged
5 tasks
@jcstein jcstein requested a review from rach-id April 19, 2023 02:15
rach-id
rach-id reviewed Apr 19, 2023
View reviewed changes
Copy link
Member

@rach-id rach-id left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The layout looks good to me 👍 👍

docs/nodes/qgb-deploy.md Outdated Show resolved Hide resolved
@jcstein jcstein mentioned this pull request Apr 28, 2023
Closed
4 tasks
@jcstein jcstein requested a review from YazzyYaz April 28, 2023 15:51
@jcstein jcstein marked this pull request as ready for review April 28, 2023 15:56
@jcstein jcstein requested a review from evan-forbes April 28, 2023 15:56
YazzyYaz
YazzyYaz approved these changes Apr 28, 2023
View reviewed changes
docs/nodes/qgb-deploy.md Outdated Show resolved Hide resolved
docs/nodes/qgb-orchestrator.md Outdated Show resolved Hide resolved
@jcstein jcstein marked this pull request as draft April 28, 2023 19:55
jcstein
jcstein commented Apr 28, 2023
View reviewed changes
docs/nodes/qgb-relayer.md Outdated Show resolved Hide resolved
@jcstein jcstein marked this pull request as ready for review April 28, 2023 20:56
@jcstein jcstein merged commit 6da47fb into main Apr 28, 2023
@jcstein jcstein deleted the jcs/add-qgb-docs branch April 28, 2023 20:56
jcstein added a commit that referenced this pull request Sep 21, 2023
@jcstein
Add QGB docs (#668)
52c4520 
* docs: add QGB docs

* fix: anchor links in imported markdown, tables

* style: add category under Validator for QGB

* align with celestiaorg/orchestrator-relayer#295

* feat: add markdown import to build command

* docs: update markdown files

* add intro section TODO

* reformat menu

* docs: add intro section

* fix: linting from source as test

* add back QGB to titles for clarity

* edit copy of intro

* update from source

* manually add changes from celestiaorg/orchestrator-relayer#334

* add intro and diagrams from #279

* linting

* add "install" section, add variable for QGB for golang, and link to internal pages

* match celestiaorg/orchestrator-relayer#337
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rach-id rach-id rach-id left review comments

@YazzyYaz YazzyYaz YazzyYaz approved these changes

@evan-forbes evan-forbes Awaiting requested review from evan-forbes

Assignees

@jcstein jcstein

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jcstein @YazzyYaz @rach-id