Skip to content

docs: prepare the repository to go public - #118

Merged
Bccorb merged 1 commit into
mainfrom
docs/public-repo-prep
Oct 17, 2026
Merged

Bccorb merged 1 commit into
mainfrom
docs/public-repo-prep

Conversation

@Bccorb

@Bccorb Bccorb commented Oct 17, 2026

Copy link
Copy Markdown
Contributor

Refs #112. Part of the v0.19 release (fells-code/seamless-auth-api#385).

What

  • README rewritten for the Astro Starlight site (it described the old React and Vite app, src/content.ts and a docs/ tree), with how to report a problem and where security reports go
  • CONTRIBUTING.md for docs: reporting, fixing a page, the checks to run, and the style rules (no H1, dated sources for competitor facts, nothing unshipped)
  • Issue templates: docs problem, missing docs, and contact links for security reports and bugs in the code repos. Blank issues are off
  • Removed leftovers from the old site: public/sitemap.xml (a static sitemap of the old /docs/... URLs, while robots.txt already points at the generated sitemap-index.xml), public/search-index.json and public/vite.svg, none of which is referenced
  • AGENTS.md: the site is Astro Starlight, content lives in src/content/docs

The org-wide code of conduct, contributing guide and security policy in fells-code/.github already apply to this repo, so they are linked, not copied.

Checks

  • npm run typecheck: 0 errors, 0 warnings
  • npm run lint: pass
  • npm run build: 51 pages, sitemap-index.xml generated

Still needed before flipping visibility (#112)

  • Contributor consent on commit author metadata becoming public (one contributor's commits carry a personal address)
  • Confirm the hosting deploy does not depend on the repo being private
  • Set the repository homepage to https://docs.seamlessauth.com

Rewrite the README for the Starlight site, add docs contribution notes
and issue templates, and remove the static sitemap, search index and
Vite asset left over from the old site.

Refs #112
@Bccorb
Bccorb merged commit e302613 into main Oct 17, 2026
3 checks passed
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