Skip to content

docs(readme): replace stale screenshot with project overview - #284

Merged
iamjr15 merged 1 commit into
mainfrom
docs/professional-readme
Aug 15, 2026
Merged

docs(readme): replace stale screenshot with project overview#284
iamjr15 merged 1 commit into
mainfrom
docs/professional-readme

Conversation

@iamjr15

@iamjr15 iamjr15 commented Aug 15, 2026

Copy link
Copy Markdown
Contributor

Summary

  • remove the unrelated ClearTax screenshot and its 432 KiB repository asset
  • add truthful CI, runtime, TypeScript, and license badges
  • add concise product navigation and a capability overview for first-time readers
  • correct nearby connected-app wording and prerequisite punctuation

Decisions

  • Removed the screenshot instead of replacing it with a private-account or fabricated product image.
  • Kept badges limited to verifiable repository facts: the real CI workflow, pinned Node and pnpm versions, strict TypeScript, and the exact PolyForm license.
  • Preserved the existing architecture, self-hosting, development, security, and license guidance.

Architecture and migrations

  • No runtime architecture, dependency, deployment, schema, or migration changes.

Verification

  • pnpm lint
  • pnpm typecheck
  • pnpm turbo build --force with the non-secret static-check build environment
  • pnpm deadcode
  • pnpm architecture:check
  • pnpm turbo skills:build
  • git diff --check
  • validated every README local path and external URL
  • rendered the README through GitHub's GFM API and confirmed badges, table, links, and Mermaid markup

Remove the unrelated ClearTax asset. Add truthful repository badges, navigation, and a
concise capability overview without publishing private product data.
@iamjr15
iamjr15 merged commit 41e0014 into main Aug 15, 2026
4 checks passed
@iamjr15
iamjr15 deleted the docs/professional-readme branch August 15, 2026 13:38
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