Skip to content

[Ready for Review] Overall Docs update - #114

Open
ankitzm wants to merge 12 commits into
mainfrom
docs/overall
Open

ankitzm wants to merge 12 commits into
mainfrom
docs/overall

Conversation

@ankitzm

@ankitzm ankitzm commented Jun 4, 2026

Copy link
Copy Markdown
Contributor

What changed

  • Added docs/getting-started.md — first-run setup walkthrough (replaces the old SETUP.md)
  • Added docs/configuration.md — config keys reference and how to set them
  • Added docs/arch.md — architecture overview
  • Moved commands.mddocs/commands.md (consolidated under docs/)
  • Renamed contributing.mdCONTRIBUTING.md (standard casing GitHub recognizes)
  • Removed SETUP.md — folded into docs/getting-started.md
  • Trimmed README.md (~140 lines removed) and re-pointed all links at the new docs/ tree
  • Updated cross-links in CHANGELOG.md, .github/ISSUE_TEMPLATE/config.yml, install.sh, and CLAUDE.md to the new doc paths
  • Minor .gitignore cleanup

Why

Documentation was scattered across the repo root (SETUP.md, commands.md, contributing.md) with overlapping content and stale links. This consolidates everything under a single docs/ tree with a clear entry point (getting-started.md), giving new users one obvious path in and keeping the README short. The code behind this (embedded/no-Docker default) is already merged into the target — this PR is the documentation catch-up.

How to test

  1. Open README.md — every doc link should resolve to a file under docs/ (or CONTRIBUTING.md); no dead links to the removed SETUP.md or root-level commands.md.
  2. Open docs/getting-started.md and follow it end-to-end — commands and references should match current CLI behavior.
  3. Spot-check docs/configuration.md against actual config keys (bytebell set …) — keys and defaults should line up.
  4. Confirm CONTRIBUTING.md renders and is linked from the README / issue templates.
  5. Check install.sh and the issue-template config.yml links point at the new docs/ paths.

Checklist before [DONE]

  • Branch name follows the rules (docs/overall)
  • Title starts with a status tag
  • What / Why / How to test sections present
  • N/A — docs only, no UI/frontend changes (no screenshots)
  • CI passes
  • Self-reviewed the diff — no broken links left behind
  • Rebased on merge/embedded_prerelease so the diff is clean

Comment thread docs/arch.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

needs to updated with open-ir as reference instead of bytebell pubic

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, let me fix the remaining

Comment thread README.md

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a video while filling the setup form that would be great in readme @ankitzm

@bharatsachya
bharatsachya self-requested a review June 9, 2026 05:38

@bharatsachya bharatsachya left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please add logo here and also remove run it in 5 minutes, also a description like immediate representation of your codebase sounds more intresting

@bharatsachya

Copy link
Copy Markdown
Contributor

Uploading Screenshot 2026-06-09 at 11.09.47 AM.png…

@ankitzm ankitzm changed the title [WIP] Overall Docs update [Ready for Review] Overall Docs update Jun 15, 2026
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.

3 participants