Skip to content

Correct the README to match what the project actually contains - #4

Merged
ialakey merged 1 commit into
masterfrom
docs/readme-accuracy
Sep 5, 2026
Merged

Correct the README to match what the project actually contains#4
ialakey merged 1 commit into
masterfrom
docs/readme-accuracy

Conversation

@ialakey

@ialakey ialakey commented Sep 5, 2026

Copy link
Copy Markdown
Owner

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 "three-repository system" table. It presented a Spring Boot API as
    the source of locations, guides and the Telegram directory. The app makes no
    backend calls; all three are bundled assets (assets/data/). Verified by
    grep — there is no API client in lib/.
  • Screenshots. They showed the pre-redesign UI: the navigation drawer and
    nested bottom bars that were replaced by a single NavigationBar. The image
    links still resolve, but they no longer show this app.
  • The iOS platform badge. ios/ has no Podfile and declares
    IPHONEOS_DEPLOYMENT_TARGET = 11.0, below what the current plugin set
    requires. It is not built or released. Now recorded honestly under
    Platforms rather than advertised.
  • Stale package referencesflutter_markdown, share, and a
    "five parsers" count that predates the rewrite.

Corrected

  • "It works with no connection." That was true when guide images were
    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.
  • Flutter/Android versions, article and section counts, and the parser count
    now match the build files and guide.json.

Added — present but undocumented

  • Android toolchain versions (AGP 9.1, Gradle 9.3.1, Kotlin 2.4, Java 17,
    targetSdk 36, minSdk 24).
  • The checklist and deadline-reminder features, including why reminder
    scheduling is deliberately inexact.
  • The exact commands CI runs, so they can be reproduced locally.
  • Why tool/validate_guide.dart and parsers.yml exist — both guard against
    silent failure, which is not obvious from the workflow files alone.

Docs only; no code changes.

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.
@ialakey
ialakey merged commit d982a11 into master Sep 5, 2026
1 check passed
@ialakey
ialakey deleted the docs/readme-accuracy branch September 5, 2026 20:47
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