Conversation
- add architecture and configuration references
…to docs/overall
Dead-Bytes
suggested changes
Jun 6, 2026
Contributor
There was a problem hiding this comment.
needs to updated with open-ir as reference instead of bytebell pubic
Contributor
Author
There was a problem hiding this comment.
yes, let me fix the remaining
Contributor
There was a problem hiding this comment.
add a video while filling the setup form that would be great in readme @ankitzm
bharatsachya
self-requested a review
June 9, 2026 05:38
bharatsachya
reviewed
Jun 9, 2026
bharatsachya
left a comment
Contributor
There was a problem hiding this comment.
please add logo here and also remove run it in 5 minutes, also a description like immediate representation of your codebase sounds more intresting
Contributor
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
docs/getting-started.md— first-run setup walkthrough (replaces the oldSETUP.md)docs/configuration.md— config keys reference and how to set themdocs/arch.md— architecture overviewcommands.md→docs/commands.md(consolidated underdocs/)contributing.md→CONTRIBUTING.md(standard casing GitHub recognizes)SETUP.md— folded intodocs/getting-started.mdREADME.md(~140 lines removed) and re-pointed all links at the newdocs/treeCHANGELOG.md,.github/ISSUE_TEMPLATE/config.yml,install.sh, andCLAUDE.mdto the new doc paths.gitignorecleanupWhy
Documentation was scattered across the repo root (
SETUP.md,commands.md,contributing.md) with overlapping content and stale links. This consolidates everything under a singledocs/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
README.md— every doc link should resolve to a file underdocs/(orCONTRIBUTING.md); no dead links to the removedSETUP.mdor root-levelcommands.md.docs/getting-started.mdand follow it end-to-end — commands and references should match current CLI behavior.docs/configuration.mdagainst actual config keys (bytebell set …) — keys and defaults should line up.CONTRIBUTING.mdrenders and is linked from the README / issue templates.install.shand the issue-templateconfig.ymllinks point at the newdocs/paths.Checklist before
[DONE]docs/overall)merge/embedded_prereleaseso the diff is clean