[Documentation] Refactor poktroll documentation so its easier to navigate - Githubissues

pokt-network / poktroll

The official Shannon upgrade implementation of the Pocket Network Protocol implemented using Rollkit.dev

MIT License

15 stars 7 forks source link

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

Closed Olshansk closed 2 months ago

Olshansk commented 2 months ago

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:

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

Issue

460

Type of change

Select one or more:

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

Testing

[x] Documentation changes: make docusaurus_start

Sanity Checklist

[x] I have tested my changes using the available tooling

Olshansk commented 2 months ago

@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

okdas commented 2 months ago

@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

okdas commented 2 months ago

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