Correct the README to match what the project actually contains - #4
Merged
Conversation
Several statements no longer described this repository: - The "three-repository system" table presented a Spring Boot API as the source of locations, guides and the chat directory. The app makes no backend calls at all — every one of those data sets is a bundled asset. - Screenshots showed the pre-redesign interface: the drawer and nested bottom bars that no longer exist. - "It works with no connection" was true of the whole guide when its images were bundled. Article images are now fetched from srb.guide, so the text is offline and the images are not. Stated as such rather than implied. - The platform badge advertised iOS. The ios/ project has no Podfile and still declares an iOS 11 deployment target, below what the current plugins require, and it is neither built nor released. Recorded as unmaintained instead of listed as a supported platform. - flutter_markdown, `share` and the five-parser count referred to packages and code that were replaced. Adds what was missing: the Android toolchain versions, the checklist and reminder features, the local check commands CI runs, and why validate_guide and the parser health job exist.
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.
The README described a version of this project that no longer exists. This
brings it in line with what is actually in the repository — every statement in
it was checked against the code, the assets and the build files.
Removed — not in this project
the source of locations, guides and the Telegram directory. The app makes no
backend calls; all three are bundled assets (
assets/data/). Verified bygrep — there is no API client in
lib/.nested bottom bars that were replaced by a single
NavigationBar. The imagelinks still resolve, but they no longer show this app.
ios/has noPodfileand declaresIPHONEOS_DEPLOYMENT_TARGET = 11.0, below what the current plugin setrequires. It is not built or released. Now recorded honestly under
Platforms rather than advertised.
flutter_markdown,share, and a"five parsers" count that predates the rewrite.
Corrected
bundled. The synced guide references 283 images hosted on srb.guide, so the
text is offline and the images are not. The README now says exactly that,
including the placeholder fallback.
now match the build files and
guide.json.Added — present but undocumented
targetSdk36,minSdk24).scheduling is deliberately inexact.
tool/validate_guide.dartandparsers.ymlexist — both guard againstsilent failure, which is not obvious from the workflow files alone.
Docs only; no code changes.