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.

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

docs: redo (mostly) everything #604

Merged
merged 65 commits into from
Jul 24, 2024
Merged

docs: redo (mostly) everything #604

merged 65 commits into from
Jul 24, 2024

Conversation

technicallyty
Copy link
Contributor

@technicallyty technicallyty commented Jul 17, 2024

the goal with this PR is to consolidate and reorganization all information in the docs. where duplicate information was found, it was consolidated to a single place i deemed appropriate.

most notable changes:

  • slimmed down the intro page. it now cuts straight to the chase: what is connect? how do i use it?
  • moved all the architecture info stuff to a new learn section
  • redo all validator sections
    • rework quickstart
    • rework configuration (mainly just putting ONLY what a validator would need to know about configuring)
    • rework troubleshooting into an FAQ page.
  • removed chain specific page -> it now lives in advanced-setups. it only makes small callouts to what each chain (dydx, neutron) needs to setup their sidecar properly).
  • removed emojis (sorry everyone) and replaced them with font-awesome icons
  • changed the highlight color to blue
  • etc etc..

in subsequent PR's ill add: architecture docs, metrics docs, self-service integration docs, and a roadmap section.

Copy link

codecov bot commented Jul 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 56.53%. Comparing base (829d644) to head (c10c2bb).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #604      +/-   ##
==========================================
- Coverage   56.55%   56.53%   -0.03%     
==========================================
  Files         250      250              
  Lines       13018    13023       +5     
==========================================
  Hits         7362     7362              
- Misses       4948     4953       +5     
  Partials      708      708              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@technicallyty technicallyty changed the title docs: redo intro page and validators section docs: redo (mostly) everything Jul 17, 2024
@technicallyty technicallyty marked this pull request as ready for review July 17, 2024 19:17
@technicallyty technicallyty merged commit 5fa16ab into main Jul 24, 2024
16 of 17 checks passed
@technicallyty technicallyty deleted the tyler/revamp-docs branch July 24, 2024 01:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants