docs: add requestAppData() to Perms sidebar - #3534
Merged
Salazareo merged 1 commit intoAug 10, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
docs: add
requestAppData()to the Perms sidebarFixes PUT-1485
What
Adds a single sidebar entry for
puter.perms.requestAppData()so its docs page is reachable from the docs navigation.Why
The
requestAppData()work shipped its docs page and landing-page links, but never got an entry insrc/docs/src/sidebar.js. Because the docs build generates both the pages and the nav fromsidebar.js, the page rendered at/Perms/requestAppData/but nothing linked to it from the sidebar — you could only reach it by typing the URL or via the one link inPerms.md.It was the only Perms doc in that state. Checking every
Perms/*.mdagainst the sidebar before the fix:Perms.mdwas already correct — it has the "Use Another App's Data" feature tab and lists the method under an Other Apps' Data heading between Apps Management and Subdomains Management. Only the sidebar was out of sync.Changes
One file, +8 lines:
src/docs/src/sidebar.jsrequestAppData()entry to thePermssectionPlaced after
requestManageApps()and beforerequestReadSubdomains(), matching the orderingPerms.mdalready uses, and following the same entry shape as its siblings (title/page_title/title_tag/icon/source/path).How I tested
Ran the docs end-to-end rather than just building:
npm run buildinsrc/docs— succeeds. The two warnings it prints are pre-existing and unrelated (ai-txt2speech-speechifyplayground example missing, referenced fromindex.mdandAI/txt2speech.md).Served
dist/and hit the page: HTTP 200 at/Perms/requestAppData/, titleputer.perms.requestAppData() - Puter.js Docs.Confirmed the sidebar link is present in the rendered HTML of sibling pages, in the same
/./Perms/…/href form as the other entries.Verified rendered sidebar order:
Screenshot:
requestManageApps()↔requestReadSubdomains().requestAppDatais implemented and exported insrc/puter-js/src/modules/perms/index.jsand typed insrc/puter-js/types/modules/perms.d.ts.Notes for review
Perms/requestAppData.mdalready exists onmain.src/docs/dist/is gitignored, so build output isn't in the diff.