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

[Documentation] Refactor poktroll documentation so its easier to navigate #474

Merged
merged 5 commits into from
Apr 11, 2024

Conversation

Olshansk
Copy link
Member

@Olshansk Olshansk commented Apr 10, 2024

Summary

  • No changes to the actual documentation
  • Create navigation bar tabs
  • Format the sidebar styling
  • Auto-expand all sidebars
  • Add search functionality (added after video was recorded)

Before:

Screen.Recording.2024-04-10.at.4.07.52.PM.mov

After:

Screen.Recording.2024-04-10.at.4.06.27.PM.mov

Issue

Type of change

Select one or more:

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Documentation
  • Other (specify)

Testing

  • Documentation changes: make docusaurus_start

Sanity Checklist

  • I have tested my changes using the available tooling

@Olshansk Olshansk added the documentation Improvements or additions to documentation label Apr 10, 2024
@Olshansk Olshansk self-assigned this Apr 10, 2024
@Olshansk Olshansk marked this pull request as ready for review April 10, 2024 23:40
@Olshansk
Copy link
Member Author

@okdas I couldn't find any github workflows that update https://dev.poktroll.com/. Where is it?

Reason why I ask:

Screenshot 2024-04-10 at 4 40 20 PM

@Olshansk Olshansk added this to the Shannon Quality of Life milestone Apr 10, 2024
@okdas
Copy link
Member

okdas commented Apr 10, 2024

@okdas I couldn't find any github workflows that update https://dev.poktroll.com/. Where is it?

This is the one: https://github.com/pokt-network/poktroll/blob/main/.github/workflows/upload-pages-artifact.yml

Copy link
Member

@okdas okdas left a comment

Choose a reason for hiding this comment

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

I like the new UI, all links seem to work. I say let's merge and see if the search index works on dev.poktroll.com.

@okdas
Copy link
Member

okdas commented Apr 11, 2024

@Olshansk there's a conflict now after the other branch is merged - I can take care of it - just LMK.

@Olshansk Olshansk merged commit dbb6a02 into main Apr 11, 2024
11 checks passed
@Olshansk Olshansk deleted the multi_sidebars_attempt2 branch April 11, 2024 03:46
bryanchriswhite added a commit that referenced this pull request Apr 11, 2024
* main:
  [Documentation] Refactor poktroll documentation so its easier to navigate (#474)
  [LocalNet] Add observability stack (#475)
  [Tokenomics] Foundation PR to integrate `SessionAccountingSettlement` w/ the Claim & Proof lifecycle (#448)
bryanchriswhite added a commit that referenced this pull request Apr 11, 2024
* main:
  [Documentation] Refactor poktroll documentation so its easier to navigate (#474)
  [LocalNet] Add observability stack (#475)
  [Tokenomics] Foundation PR to integrate `SessionAccountingSettlement` w/ the Claim & Proof lifecycle (#448)
Olshansk added a commit that referenced this pull request Apr 11, 2024
…gate (#474)

- No changes to the actual documentation
- Create navigation bar tabs
- Format the sidebar styling
- Auto-expand all sidebars
- Add search functionality (added after video was recorded)

**Before:**

https://github.com/pokt-network/poktroll/assets/1892194/b6bcc4fa-6504-432f-90ea-ab36f7bd4fdc

**After:**

https://github.com/pokt-network/poktroll/assets/1892194/5635ca1d-9f8d-48c5-906b-574c95c11b26
bryanchriswhite added a commit that referenced this pull request Apr 17, 2024
* pokt/main:
  [TODOs] Add todos for future smt optimizations (#423)
  [Metrics] feat: Initial on-chain metrics implementation (#449)
  [Tooling] Add application stake/unstake/delegate logs (#482)
  [SMT] Updated smt release from v0.9.2 -> v0.10.2 (#472)
  [Docs] update supplier actor CLI section (#471)
  [Testing] chore: add make targets & update feature path logging (#470)
  [Metrics] Additional off-chain metrics (#468)
  Update test instructions pull_request_template.md (#473)
  [Tooling] Makefile checkers when starting localnet (#466)
  [LocalNet] Switch validator logs to json (#480)
  [Documentation] Refactor poktroll documentation so its easier to navigate (#474)
  [LocalNet] Add observability stack (#475)
okdas pushed a commit that referenced this pull request Nov 14, 2024
…gate (#474)

- No changes to the actual documentation
- Create navigation bar tabs
- Format the sidebar styling
- Auto-expand all sidebars
- Add search functionality (added after video was recorded)

**Before:**

https://github.com/pokt-network/poktroll/assets/1892194/b6bcc4fa-6504-432f-90ea-ab36f7bd4fdc

**After:**

https://github.com/pokt-network/poktroll/assets/1892194/5635ca1d-9f8d-48c5-906b-574c95c11b26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

2 participants