docs: point the README at the docs site and fix two claims - #179
Merged
Conversation
The README never mentioned mockifyr.omercelik.dev. Someone landing on the repository had no way to know 26 pages of guides and reference existed, and the Documentation section listed only ARCHITECTURE.md, the roadmap and CLAUDE.md — all of them contributor material. It now splits by audience: using Mockifyr points at the site, working on Mockifyr points in-repo, and the top of the file carries a single link for people who read no further. Two claims were wrong. `Mockifyr.Facade.Library` was described as a "package", which sends a reader to nuget.org. Directory.Build.props sets IsPackable=false for every project, so nothing is published; the README now says so and tells you to reference the project from a checkout instead. The configuration section said "everything is a CLI flag" without saying that the host builds configuration with the standard .NET builder, so every flag is also an environment variable of the same name. That is the reason `-e admin-user=alice` works on `docker run`, and it was undocumented in both places until now. The README logo moves from the two-tone duo mark to the monochrome one, so it matches the dashboard, the docs site and the favicon. The duo variant stays in brand/ for cases that want it. Verified: all 20 documentation links return 200 against the live site. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
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.
The README never mentioned mockifyr.omercelik.dev. Someone landing on the repository had no way to know 26 pages of guides and reference existed — the Documentation section listed only
ARCHITECTURE.md, the roadmap andCLAUDE.md, all of it contributor material.Two wrong claims
Mockifyr.Facade.Librarywas described as a "package." That sends a reader to nuget.org.Directory.Build.propssetsIsPackable=falsefor every project, so nothing is published. The README now says so and points at referencing the project from a checkout."Everything is a CLI flag" was true but incomplete. The host builds configuration with
WebApplication.CreateBuilder(args)and reads plain keys, so every flag is also readable as an environment variable of the same name — which is why-e admin-user=aliceworks ondocker run, and it was undocumented in both the README and the site until now.Documentation section, split by audience
ARCHITECTURE.md, the roadmap, decisions,docs/parity/,brand/,CLAUDE.md.A single documentation link also sits directly under the intro, for people who read no further than the first screen.
Logo
The README used
mockifyr-mark-duo.svg, the two-tone variant — the odd one out, since the dashboard, the docs site and the favicon all use the monochrome mark with the blue eye as the only accent. It now usesmockifyr-mark-black.svgon light andmockifyr-mark-white.svgon dark. The duo variant stays inbrand/for cases that want it.Verification
All 20 documentation links checked against the live site — every one returns 200.
🤖 Generated with Claude Code