docs: restyle README to match the CodeBoarding repo#4
Merged
Conversation
Match the engine repo's README formatting: plain title + tagline + intro, a `·`-separated links line, language badges, sentence-case section headers, period-terminated bullets, lighter bold, and no emoji legend (drop the centered logo block). Content is unchanged — formatting only.
Title -> 'CodeBoarding Review'. Replace the toy gateway/cache sample with CodeBoarding's actual level-1 components (from .codeboarding/analysis.json), colored as a diff: 1 added (green), 2 modified (yellow), 1 deleted (red dashed), with edges colored to match.
Default OpenRouter runs to google/gemini-3-flash-preview (agent) and google/gemini-3.1-flash-lite-preview (parsing) when the user doesn't pin a model. Gated on provider==openrouter, so other providers still defer to their own engine default (multi-provider intact). Both slugs verified to exist on OpenRouter. Remove the 'Model format on OpenRouter ...' README paragraph and update the Inputs table.
Add an early sticky-comment step (same 'codeboarding-architecture-diff' header) right after the guard, before the multi-minute checkout/analysis, so the PR shows an 'analyzing…' comment within seconds. The final post step edits that same comment in place with the diagram (and the failure step replaces it on error). best-effort (continue-on-error) so a placeholder hiccup can't fail the run. Consumers get the Qodo/CodeRabbit-style placeholder for free.
The CI lint job (shellcheck) failed on three info-level findings in run_local.sh
(pre-existing since the run_engine rewrite): SC2030/SC2031 from re-exporting
OPENROUTER_API_KEY inside run_engine's subshell, and SC2015 from the
A && B && C || {…} precondition. Drop the redundant key re-export (it's inherited
from the env) and rewrite the precondition as an if. shellcheck now passes.
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
1 participant
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.
Formatting-only pass to align the action README with the
CodeBoardingengine repo's README style.·-separated links line + the same language badges.Content is unchanged — formatting only. Open questions for review: keeping the logo removed, and
Usage→Quick start.