Skip to content

Docs/sidebar match application main#76

Closed
LaurenceJJones wants to merge 4 commits intofosrl:mainfrom
LaurenceJJones:docs/sidebar-match-application-main
Closed

Docs/sidebar match application main#76
LaurenceJJones wants to merge 4 commits intofosrl:mainfrom
LaurenceJJones:docs/sidebar-match-application-main

Conversation

@LaurenceJJones
Copy link
Copy Markdown
Member

Major rewrite of documentation to aid users to find appropriate documentation by matching the application sidebar to the documentation.

@miloschwartz
Copy link
Copy Markdown
Member

@LaurenceJJones After looking at this, we decided not to make the sidebar match the application because the things people go to the docs for don't necessarily always fit into one of the pages in the app. It results in a bunch of unnecessary docs -- like the general page of sites -- that I could see getting out of sync.

However, I do see some good stuff in here for things that aren't documented yet or aren't documented well like the headers and query param access tokens parts of a share link for example. Can you open specific, smaller PRs for things that are missing that are important features to highlight? I think it's good to be very selective and intentional about this and focus on things that people are usually generally confused about or are powerful features that are buried in the applications that we can surface in the docs.

Other general feedback would be to remove a lot of fluff from docs and only discuss the parts that are confusing, potentially confusing, technically complicated, or features that we want to highlight uses cases / guides so people know how to use the product. Using the same share link page as an example, there are a lot of sections at the top which are filler and don't add any substance.

vailable controls in this view include:

- **Create Share Link** to open link creation
- **Refresh** to reload the table and pull links created or updated by other users in your organization
- Search to quickly find links
- Sortable table columns (for example **Title**, **Resource**, **Created**, **Expires**)
- Pagination controls for navigating larger link sets

Use this list to:

- Review which links exist and what they are used for
- Confirm which links are active or expired
- Track when links were created and when they expire
- Revoke links when access should end

To revoke a link or its access token, delete the link from **Manage Share Links**.

LaurenceJJones added a commit to LaurenceJJones/pangolin-docs-v2 that referenced this pull request Mar 23, 2026
LaurenceJJones added a commit to LaurenceJJones/pangolin-docs-v2 that referenced this pull request Mar 23, 2026
LaurenceJJones added a commit to LaurenceJJones/pangolin-docs-v2 that referenced this pull request Mar 23, 2026
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.

2 participants