docs: add an indexable landing page served from docs/ - #6
Merged
Merged
Conversation
A single self-contained page for GitHub Pages. No external requests: fonts come from system stacks, and the only assets are the screenshot and the page itself. For search: title and meta description, canonical URL, Open Graph and Twitter card tags, JSON-LD SoftwareSourceCode describing the project and crediting the original author, semantic headings, descriptive alt text, plus robots.txt and sitemap.xml. The page is built from the source rather than around it. The colour ramp it shows is the app's own depth colormap, regenerated with the formula from GLView.m - which is also how the page can point out that the cubic gamma spends the whole spectrum by depth value ~1150 and clips everything beyond it to black, the reason the app carries clipping controls at all. The screenshot is served as WebP (126 KB) with the original JPEG (353 KB) as fallback. The JPEG is kept unrecompressed as the archival capture and for Open Graph scrapers, which handle WebP poorly.
…d sizing The tick labels inherited the paragraph reading measure while the ramp itself spanned the container, so the depth values sat under the wrong colours - on a page whose point is that the ramp is faithful. Also sets min-width:0 on the comparison table and its grid parent. Grid items default to min-width:auto, so a table with a min-width can refuse to shrink and widen the page. Measured before and after: no horizontal overflow at 320px or 390px either way, so this is a guard rather than a fix. Rendered headless at 390, 768 and 1280 while checking.
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.
What this changes
Adds a landing page at
docs/index.html, ready to serve via GitHub Pages from thedocs/folder, plusrobots.txt,sitemap.xmland.nojekyll.Why
The project is an archive meant to be found and read. A repository README is not indexable as a page with its own title, description and structured data; this is.
For search engines: title and meta description, canonical URL, Open Graph and Twitter card tags, JSON-LD
SoftwareSourceCodenaming Robert Pointon as author and libfreenect as the basis, semantic heading structure, descriptive alt text,robots.txtandsitemap.xml.For readers: what the app does, whose work it is and what that means for reuse, what was fixed since 2010 with the measured numbers, and the real build situation — Intel builds, Apple Silicon needs libusb rebuilt.
The page is derived from the source rather than decorated around it. Its colour ramp is the app's own depth colormap, regenerated with the formula from
GLView.m. That also surfaces something true about the code: the cubic gamma spends the entire visible spectrum by depth value ~1150 and clips everything past it to black, which is why the app carries near and far clipping controls.Weight
No external requests — no web fonts, no CDN, no analytics. Typography uses system font stacks. The screenshot is served as WebP at 126 KB with the original 353 KB JPEG as a fallback; the JPEG is deliberately left unrecompressed as the archival capture, and because Open Graph scrapers handle WebP poorly.
How it was verified
sh scripts/syntax-check.shpasses (no source changes)GLView.m, not eyeballedThe last one is worth doing before enabling Pages. The page is responsive by construction, respects keyboard focus, and has no motion to disable, but it has not been opened in a browser here.
After merging
GitHub Pages needs enabling: Settings → Pages → Deploy from a branch →
main/docs. The canonical URL in the page assumeshttps://gridboy.github.io/cocoa_kinect/.Provenance
CONTRIBorAUTHORSfile altered