docs: student-friendly theory, site nav, and Results polish - #77
Merged
Conversation
Expand definitions and transitions across Serialization 101–401 so first-year readers can follow jargon. Links, diagrams, and technical meaning preserved. Further sentence-level rewrites still needed for dense original passages.
…r readers Rewrite Serialization 101–401 articles into clear textbook English. Split dense multi-clause sentences, define technical terms in plain language, and replace remaining industry jargon without changing meaning. Preserve links, diagrams, code samples, and technical claims.
Add a /clean-logs skill and script that keep only the latest run stem per language. Refresh available_runs.json to match the pruned set so the dashboard run picker stays consistent.
Restructure site nav to Dashboard | Learn | Languages | Method so the interactive dashboard is a first-class tab instead of a nested item under Benchmarks. Point Method and theory cross-links at the new tabs.
Replace the local “Serializer Analytics” header and “Back to Docs” escape hatch with the docs product wordmark and peer links (Dashboard · Learn · Languages · Method · GitHub). Section tabs are Overview · Details · Compare · History. Filter bar, meta panels, and analytics styling are unchanged.
Keep the before/after HTML mock and screenshot used to approve the shared wordmark header design.
Replace the root redirect to Serialization 101 with a home storefront that dual-CTAs into Dashboard and Learn, and links Languages and Method. Root URL is now the project front door (Proposal D).
Make language sidebar rows short and clickable (name · Results), sort languages alphabetically, and land the Languages tab on C. Refine the storefront (no Home title, Serializers table matching the menu), hide auto page titles when requested, and standardize each language overview to intro + Benchmark runner + sorted Serializers without suite-type sections. Dashboard site peers use a GitHub icon and link Languages to C.
Document the Dashboard Samples outlier policy (default IQR k=1.5) on language Results pages. Drop Fidelity and Samples-count columns from Summary, label Total Time columns in µs, and add an Ops/Sec Average column matching Dashboard all@all aggregation. Regenerate published results and violin plots.
Drop header-wordmark and languages-nav mock HTML/PNG used during design review; they are not part of the published site.
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
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.
Summary
Lang · Results); shared dashboard header wordmark.Validation
sync-data.pyverified latest*_latest.json.gzpresent (no gzip churn committed for this docs-only gate)Notes
dashboard/mocks/removed.