Skip to content

Make the site easier for search and answer engines to quote - #100

Merged
benjamindehli merged 3 commits into
mainfrom
feature/site-answers
Nov 1, 2026
Merged

benjamindehli merged 3 commits into
mainfrom
feature/site-answers

Conversation

@benjamindehli

Copy link
Copy Markdown
Owner

I checked the docs site against current search and answer engine practice. Titles, descriptions, canonical links, share cards, the sitemap, image alt text and sizes, links and the structured data were all in order. Three things were behind 1.16.0 or missing, and this branch fixes them in three commits.

Describe picking channels in llms.txt

llms.txt is the short summary answer engines read first, and it said nothing about picking channels by their numbers, which came in 1.16.0. It now has a LINK entry that says what one drag can move and how to pick channels, and the Macros entry names the picked channels as a scope, kept as the macro's own copy. The Controls line mentions it too. I also fixed a double comma in the Combo part of the oscillator character entry.

List the characters and LINK in the structured data

The feature list in the software's structured data had thirteen entries and none of them was the oscillator characters, which is what sets the instrument apart more than anything. It now lists the twelve characters, with the six measured ones described by the kind of instrument they come from, and LINK with picked channels.

Give each preset its own address

A preset on the presets page had no id, so nothing could link to one, and a question about one preset could only be answered with the whole page. build_site.py now gives each entry in a preset list an id taken from its clip's file name, such as presets/#preset-combo-organ, and puts that address in the preset's AudioObject as its url. Because the id comes from the clip, a new preset gets one without anyone adding it, and --check fails if one is missing or edited by hand. A jump to a preset lands with the same margin as a jump to a section.

What changes for users

  • A link to one preset, such as https://benjamindehli.github.io/overtonium/presets/#preset-combo-organ, opens the page at that preset.
  • Nothing on the pages looks different.

How it was checked

  • build_site.py --check, prettier, the structured data gate, the counts gate, the lambda scan and the CSS cascade check all pass.
  • All 41 presets have an id, and all 41 preset clips carry the matching url. No other page changed, and no page's last-modified day moved.
  • In Chromium, a link to a preset and a link to a section both land 18 px from the top on a desktop and 80 px down on a phone, under the menu bar.

@benjamindehli benjamindehli self-assigned this Nov 1, 2026
@benjamindehli benjamindehli added the documentation Improvements or additions to documentation label Nov 1, 2026
@benjamindehli
benjamindehli merged commit 54b1f5c into main Nov 1, 2026
12 checks passed
@benjamindehli
benjamindehli deleted the feature/site-answers branch November 1, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant