Skip to content

docs: improve authGD discoverability and licensing - #156

Merged
guarzo merged 2 commits into
mainfrom
worktree-docs-discoverability-licensing
Aug 6, 2026
Merged

docs: improve authGD discoverability and licensing#156
guarzo merged 2 commits into
mainfrom
worktree-docs-discoverability-licensing

Conversation

@guarzo

@guarzo guarzo commented Aug 6, 2026

Copy link
Copy Markdown
Owner

Documentation, licensing, and repository-metadata pass. No application behavior changes — no TypeScript, CSS, migrations, tests, or runtime configuration in the diff, and public/ is byte-identical, so the running site's imagery is untouched.

What changed

File Change
README.md Rewritten for discoverability and accuracy — descriptive H1, badges, SVG hero, a scope callout, "What authGD manages" and fit/not-fit tables, the four-tier table with Pending, a Payout operations section, an FAQ, and a split License section
LICENSE Trimmed to standard MIT only; the Artwork and EVE Online sections moved out verbatim
ARTWORK-LICENSE.md New — Faoble's four public/brand/*.webp files, credit-required terms unchanged
NOTICE.md New — the CCP/EVE trademark notice, plus the vendored EVE SSO login button
.github/SECURITY.md New — points at private vulnerability reporting, now enabled on the repo
docs/assets/authgd-hero.svg New architecture diagram, with <title>/<desc> for screen readers
docs/assets/authgd-social-preview.png New 1280×640 social card
docs/assets/hero.png Removed — the old README was its only reference

The license split is the point: keeping LICENSE as unmodified MIT should let GitHub's detector report MIT instead of other, while the artwork permission and CCP notice survive intact in their own files.

Corrections made against the code

Several statements in the previous README were stale or wrong, and were fixed against source rather than carried forward:

  • Sync job list omitted the weekly affiliation recheck and the daily purge (src/core/schedules.ts:10-17).
  • APP_BASE_URL no longer warns about trailing slashes — src/config.ts:30-36 normalizes to origin plus path and strips them.
  • Artwork scope. The old LICENSE claimed all of public/ was Faoble's work. public/brand/ holds five tracked files; the fifth is CCP's EVE SSO login button used at src/app/login/page.tsx:175. It is now covered by NOTICE.md, with a cross-reference from ARTWORK-LICENSE.md.
  • Contact-label matching now states that authGD refuses to guess when two labels are fold-equal and neither matches exactly (src/core/contact-label.ts:38-45).
  • Payout authorization is documented for the first time: reading requires tier member at any status, so a cryo account still sees history; creating and editing require an active member account (src/services/payouts.ts:42-50).

CONTRIBUTING.md links README.md#quickstart-local-development and #making-it-yours, so both headings were kept verbatim.

Repository metadata

Already applied out-of-band and verified: a description, 19 topics, private vulnerability reporting enabled, and the social preview uploaded. Homepage deliberately left empty — there is no distinct public project site.

Verification

Check Result
npm test 77 files, 1144 tests passed
npm run test:e2e 225 passed
npm run build succeeded
docker build . exit 0
npm run typecheck / lint / format:check clean
scripts/check-node-version.sh Dockerfile=24 .nvmrc=24 engines='>=24'

Every relative link and heading anchor in the new and edited files was checked to resolve, including the two inbound anchors from CONTRIBUTING.md.

Review focus

The licensing files. Confirm every tracked file under public/brand/ is claimed by exactly one of LICENSE, ARTWORK-LICENSE.md, or NOTICE.md, and that Faoble's permission is neither broadened nor narrowed from the original wording.

@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 31 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 0dd477df-33e7-432a-8d5f-5f670dd52537

📥 Commits

Reviewing files that changed from the base of the PR and between c578561 and e411ffc.

⛔ Files ignored due to path filters (3)
  • docs/assets/authgd-hero.svg is excluded by !**/*.svg, !docs/assets/**
  • docs/assets/authgd-social-preview.png is excluded by !**/*.png, !docs/assets/**
  • docs/assets/hero.png is excluded by !**/*.png, !docs/assets/**
📒 Files selected for processing (5)
  • .github/SECURITY.md
  • ARTWORK-LICENSE.md
  • LICENSE
  • NOTICE.md
  • README.md

Comment @coderabbitai help to get the list of available commands.

@guarzo
guarzo merged commit a228e58 into main Aug 6, 2026
7 checks passed
guarzo added a commit that referenced this pull request Aug 6, 2026
main moved under this run: #150, #152, #153 and #156 merged while the
sweep was working, and #153 landed in `confirm-submit.tsx`, which round
one had rewritten. GitHub reported #148 CONFLICTING/DIRTY.

The conflict was two independent edits to one file, resolved by keeping
both rather than choosing:

- Round one replaced the `ch`-arithmetic width reservation with CSS
  generated content (`data-ghost-label`). #153's docblock paragraph
  describing the old `ch` reservation is superseded and dropped, along
  with its `widthCh` constant, which nothing renders any more.
- #153 added the `confirm` prop, the below-the-hooks throw, and the
  `confirm && ctx?.armedId === id` arming test, all of which are about
  component-type stability in the pay flow and untouched by round one.
  Kept verbatim, comments included.

Verified rather than assumed: #153's own regression spec — "a second
row's mark paid button survives the first payment's arm-to-plain
transition" (`e2e/payouts.spec.ts:2212`) — passes on the merge.
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