Skip to content

docs: rewrite project README - #64

Merged
umeraamir09 merged 2 commits into
mainfrom
docs/readme-refresh
Oct 6, 2026
Merged

umeraamir09 merged 2 commits into
mainfrom
docs/readme-refresh

Conversation

@umeraamir09

Copy link
Copy Markdown
Owner

Summary

  • Replace the old README with a verified overview of the app, integrations, stack, local setup, configuration, scripts, and repository layout.
  • Reuse the repository logo at public/logo_header.png and link the deployment, contribution, and draft community-policy documents.
  • Mark CODE_OF_CONDUCT.md as a draft rather than an adopted policy.

Validation

  • Checked 14 Markdown links/images and confirmed local targets exist.
  • Confirmed documented npm run commands match package.json.
  • git diff --check passed.
  • npm run lint passed.
  • npx tsc --noEmit passed.
  • Full application tests were not run because this is a README-only change.

Stacking

This PR targets docs/open-source-readiness (PR #63) to avoid competing README edits and to make the contribution and community-policy files available through relative links. It uses a new branch, docs/readme-refresh; PR #63's branch is unchanged.

@github-actions

github-actions Bot commented Oct 5, 2026

Copy link
Copy Markdown

Model not found: opencode/deepseek-v4-flash-free. Did you mean: ling-3.0-flash-fin-free, ling-3.1-flash-free, mimo-v2.6-flash-free?

opencode session  |  github run

Base automatically changed from docs/open-source-readiness to main October 6, 2026 09:43
Updated the Code of Conduct section to reflect project status.
@umeraamir09
umeraamir09 merged commit b89362a into main Oct 6, 2026
1 of 2 checks passed
@umeraamir09
umeraamir09 deleted the docs/readme-refresh branch October 6, 2026 09:50
@github-actions

github-actions Bot commented Oct 6, 2026

Copy link
Copy Markdown

fatal: couldn't find remote ref docs/readme-refresh

opencode session  |  github run

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