Skip to content

Docs: clarify GitHub connect sign-in, scope and managed config - #3031

Merged
HypForge merged 1 commit into
masterfrom
docs-github-connect-followup
Nov 18, 2026
Merged

HypForge merged 1 commit into
masterfrom
docs-github-connect-followup

Conversation

@HypForge

Copy link
Copy Markdown
Contributor

Docs follow-up to #3026. Docs only, no behavior change, nothing under hypaware-core/skills/.

  • docs/integrations/github.md:
    • The scope sentence now says HypAware asks for repo because GitHub has no read-only option. The old text read as if GitHub picked the scope. This matches the sign-in code and the message login prints.
    • "Follow the device-code instructions" now says what happens: a code in the terminal, GitHub in the browser.
    • New sentence for managed machines. When the organization's config names the plugin, connect leaves it as set. When it turns GitHub or the context graph off, connect writes nothing and tells you to contact your administrator.
  • docs/workflows/see-where-the-work-goes.md: the Pull requests line pointed at re-running hyp setup. Setup offers GitHub only when the config has no GitHub entry yet, so that step can fail to offer it. The line now points at hyp github connect, as the Tickets line points at hyp linear connect.

These docs name hyp github connect, which npm 1.53.0 does not have, the same as the page they sit on.

@HypForge

Copy link
Copy Markdown
Contributor Author

Final review (HypForge steward) at head 903ce05.

Rating: LOW. Clean. Docs only: two pages, no code, nothing under hypaware-core/skills/.

What was checked:

  • Text. A second seat (team-documentarian) confirmed every changed sentence matches its proposed wording from the Add standalone GitHub connection flow #3026 docs check word for word.
  • Code at master 6282dc0. I checked each sentence against the code:
    • Sign-in posts scope: 'repo', and login prints the "no read-only option" reason.
    • The command shows the code and opens the browser unless --no-browser is given.
    • Connect leaves a plugin that the organization's config names as set. It refuses a central enabled: false on @hypaware/github or @hypaware/context-graph before any write, with the administrator message.
    • Setup offers GitHub only when the config has no @hypaware/github entry, so pointing the workflows page at hyp github connect is correct.
  • Style. No em dashes, and the lines are wrapped like the rest of the page.
  • CPU and memory: no concern. Docs only.
  • Privacy: LOW (hypforge LLP 0015 scale). The scope disclosure is now clearer. Nothing about collection changes.

Gates:

  • Server-suite gate: not triggered (docs only; no CLI command, contract, MCP codec or schema change).
  • CI green at this head, test-windows included; CLEAN.

Note for landing: these docs name hyp github connect, which npm 1.53.0 lacks, the same as the page they sit on. The standing hold on site deploys covers it.

@HypForge

Copy link
Copy Markdown
Contributor Author

Landing note (HypForge orchestrator): enqueuing at 903ce05. HypForge opened this PR for three docs fixes that the documentation check found after #3026 merged. It lands on a clean LOW review with green checks, so there is no merge ask.

  • Review: LOW, clean, at this exact head (final comment above, 6967432691). A second seat confirmed the text against its proposed wording. Docs only; nothing under hypaware-core/skills/.
  • Server-suite gate: not triggered. CPU and memory: no concern. Privacy LOW.
  • Guard: open, not a draft, CLEAN, all checks green including test-windows, master CI green on 6282dc0, no release PR open.
  • These pages name hyp github connect, which the published 1.53.0 does not have. The hold on site deploys covers it.

@HypForge
HypForge added this pull request to the merge queue Nov 18, 2026
Merged via the queue into master with commit c091c12 Nov 18, 2026
11 checks passed
@HypForge
HypForge deleted the docs-github-connect-followup branch November 18, 2026 02:50
@HypForge

Copy link
Copy Markdown
Contributor Author

Merged (HypForge orchestrator) as c091c12 at 02:50:40Z on 2026-11-18, on the first pass through the merge queue. CI on the merge commit is green. Docs only; the pages reach the site with the first site deploy after the next client release.

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.

1 participant