Skip to content

docs: fix Pages workflow link and separate library technical debt - #6039

Open
mariusyo07 wants to merge 2 commits into
boykopovar:mainfrom
mariusyo07:docs/workflow-link-and-debt-cleanup
Open

mariusyo07 wants to merge 2 commits into
boykopovar:mainfrom
mariusyo07:docs/workflow-link-and-debt-cleanup

Conversation

@mariusyo07

Copy link
Copy Markdown
Contributor

What

Fixes 3 documentation and technical debt issues:

  1. Broken workflow link in docs/dev/PROGRESS.md: Points to .github/workflows/pages.yml (Pages workflow) instead of the non-existent progress.yml.
  2. Misplaced libSceNetCtl technical debt: Moves the unkeyed sceNetCtlGetIfStat technical debt entry from docs/dev/TechnicalDebt.md to docs/dev/debt/libSceNetCtl.md with its markdown link to core/libs/prx/libSceNetCtl/Export.cpp, in accordance with the convention that library-specific debt resides in docs/dev/debt/<library>.md.
  3. Misplaced libSceNpSessionSignaling technical debt: Moves sceNpSessionSignalingGetGroupFromSessionId (imported by PPSA07411, declared without parameters and unimplemented in core/libs/prx/libSceNpSessionSignaling/Export.cpp) from docs/dev/debt/libSceSsl.md to docs/dev/debt/libSceNpSessionSignaling.md under ### Unknown function info, and updates libSceSsl.md to cleanly describe only sceSslEnableVerifyOption.

Tested

  • python3 tools/check_conventions.py --base upstream/main: all conventions checks passed.
  • git diff --check: passes with no whitespace or style warnings.
  • python3 tools/pr_overlap.py --branch docs/workflow-link-and-debt-cleanup: no overlap with open pull requests.
  • python3 -m unittest discover -s tools/tests: 399 tests ran, all passed (2 expected skips).
  • python3 tools/check_main_sync.py: clean merge against upstream/main.

Checklist

  • Based on current main; no other open PR implements the same functions
  • One topic per PR; follow-ups go in a new PR
  • No comments in code except technical debt
  • Unimplemented paths throw (NotImplemented_nid_no_patch); silent stubs are listed under Silent stubs in their library's technical debt file
  • No notes, investigation .md files or images added to the repository (attach them to this PR)
  • New third-party code is a submodule built from source
  • Generic behaviour, not specific to one title
  • Depends on: none
  • Unblocks: none
  • GPUs tested: n/a
  • AI-assisted: yes

Copilot AI balanced review requested due to automatic review settings October 14, 2026 20:12

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@github-actions

github-actions Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Some comparisons could not be completed because a pull request conflicts with the base branch. Review these shared files manually before concluding that there is no overlap.

Pull request Shared files not compared
PR 907 docs/dev/TechnicalDebt.md
PR 1368 docs/dev/TechnicalDebt.md
PR 1384 docs/dev/TechnicalDebt.md
PR 1395 docs/dev/TechnicalDebt.md
PR 1601 docs/dev/TechnicalDebt.md
PR 1835 docs/dev/TechnicalDebt.md
PR 2780 docs/dev/TechnicalDebt.md
PR 3986 docs/dev/TechnicalDebt.md
PR 5021 docs/dev/TechnicalDebt.md
PR 6126 docs/dev/debt/libSceJson2.md
PR 6138 docs/dev/debt/libSceNetCtl.md
PR 6323 docs/dev/PROGRESS.md
PR 6511 docs/dev/debt/libSceSsl.md
PR 6643 docs/dev/PROGRESS.md
PR 6685 docs/dev/debt/libSceNetCtl.md
PR 6720 docs/dev/debt/libSceNetCtl.md
PR 6758 docs/dev/TechnicalDebt.md
PR 6964 docs/dev/debt/libSceJson2.md
PR 7215 docs/dev/debt/libSceJson2.md
PR 7319 docs/dev/debt/libSceSsl.md
PR 7332 docs/dev/debt/libSceNetCtl.md
PR 7477 docs/dev/debt/libSceJson2.md

@fma-rc

fma-rc commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

The new debt/libSceSsl.md line keeps only sceSslEnableVerifyOption. The old line also recorded the four sce::Json::Value members (setElementAccessFailureHandler, setSpecialFloatHandler, setTypeMismatchHandler, operator bool) that PPSA07411 imports without known signatures, and debt/libSceJson2.md on main has no entry for them, so that debt disappears with this change. Could you move it to debt/libSceJson2.md the way you moved the NetCtl entry? (The ConvertKeycode part is fine to drop, debt/libSceConvertKeycode.md already has it.)

PR 5911 also edits debt/libSceSsl.md and debt/libSceJson2.md, so one of the two will need a rebase after the other lands.

- docs/dev/PROGRESS.md: update Progress workflow link to point to pages.yml.
- docs/dev/debt/libSceNetCtl.md: move unkeyed sceNetCtlGetIfStat debt entry from TechnicalDebt.md to libSceNetCtl.md with link to Export.cpp.
- docs/dev/debt/libSceNpSessionSignaling.md: move sceNpSessionSignalingGetGroupFromSessionId from libSceSsl.md to libSceNpSessionSignaling.md.
@mariusyo07
mariusyo07 force-pushed the docs/workflow-link-and-debt-cleanup branch from c45b5eb to bda2614 Compare October 16, 2026 07:25
@github-actions github-actions Bot added the needs rebase Conflicts with main, rebase needed label Oct 16, 2026
@adriadam10 adriadam10 self-assigned this Oct 16, 2026

@adriadam10 adriadam10 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for this. It now conflicts with main, and part of it is obsolete:

  • docs/dev/debt/libSceSsl.md: main removed the ### Functional section, since sceSslEnableVerifyOption is implemented now, so the conflict is real.
  • docs/dev/debt/libSceJson2.md line 13 on main already holds the whole PPSA07411 entry (the four sce::Json::Value members, sceConvertKeycodeGetCharacter and sceNpSessionSignalingGetGroupFromSessionId), so the new Json2 line and the new libSceNpSessionSignaling.md line would duplicate it.

Please rebase on main and drop those hunks (libSceJson2.md, libSceNpSessionSignaling.md, libSceSsl.md). The rest is fine and still needed: the PROGRESS.md link (progress.yml doesn't exist, pages.yml does) and moving sceNetCtlGetIfStat from TechnicalDebt.md to debt/libSceNetCtl.md. With only those two it should be mergeable.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs needs rebase Conflicts with main, rebase needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants