docs: fix the quickstart a reader would paste, and add the files a public repo is judged on - #183
Merged
Merged
Conversation
…blic repo is judged on
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.
A pre-first-public-release pass over documentation, examples and repo hygiene. Two real defects, three missing files, and a lot that turned out fine.
The README's flagship demo did not work
The "Quick demo: add a firewall rule" body sends
"dest_port": [22]. The schema types those items as strings, so the first thing a curious reader pastes returns:["22"]returns 200 with the rule's id. Verified both ways on a device.Found by validating every documented request body against its endpoint's request schema rather than reading them, which is the same conformance approach that found this cycle's schema defects. 4 bodies matched the extractor, 1 was invalid.
A shipped example failed when run
examples/curl/uhttpd_instances.shexits 52. Patching themainuhttpd instance restarts the server answering the request, so curl reports "Empty reply from server" even though the write committed. Nothing in the script said so, and a newcomer running the examples would conclude uapi is broken.It now says what happens, tolerates the disconnect, and reads the instance back once uhttpd is listening again. All 16 examples run green against a real device; before this, 15 did.
Three files a public repo is judged on
guy.godfroy@gugod.fr, the identity that already authors the commits and signs the tags, so it publishes nothing new. Security stays onSECURITY.md's private path. Change the address if you would rather route it elsewhere.*.ucis tab-indented (878, 231 and 222 tab-started lines in the three largest lib files, against 1 to 3 space-started continuation lines), and a contributor's editor should not have to guess.* text=auto eol=lf. This tree lands on OpenWrt, where a CRLF in an init script or a uci-defaults hook fails at a shell that gives no useful error.One stale claim in CONTRIBUTING
make testwas described as "lint + 600+ unit tests"; the suite is at 1230. Rewritten to not carry a number that rots, since that is the second time today a hand-written count has gone stale.What was checked and is clean
TODO,FIXME,HACK,XXXor debug output in shipped code. The two marker hits aredebug.syslogdoing its job and uci'scfgXXXXXXanonymous-section naming; everyprintfis in the CLI, where printing is the point.docs/exactly: 22 entries, 22 files, no orphans and nothing dangling.maketarget README and CONTRIBUTING tell a contributor to run exists in the Makefile./api/v3.uc.out,feedback/and.claude/are all untracked or ignored.Was it verified against a real device, or only by CI? On a device throughout: the README body both ways, all 16 examples end to end, and the uhttpd example's restart-and-recover path including confirming the API came back and
ucode_prefixsurvived.make lint, 1230 unit tests,coverageandopenapi-checkpass.Does this change the wire surface? No. Documentation, examples and repo metadata only.