Skip to content

Collapse feature detail into details/summary blocks - #1

Open
tmelliottjr wants to merge 5 commits into
mainfrom
docs/collapsible-features
Open

Collapse feature detail into details/summary blocks#1
tmelliottjr wants to merge 5 commits into
mainfrom
docs/collapsible-features

Conversation

@tmelliottjr

Copy link
Copy Markdown
Owner

What

The README carried a short Features list and then eight standalone sections expanding on those same features. All that detail sat between a reader and the rest of the docs, so the page opened with ~200 lines of implementation prose before Install.

Each feature is now a <details>/<summary> block. The summary is the highlight; expanding it gives the detail that used to live further down.

Where the detail went

Was a section Now folded into
Docked mode, Collapsing a dock Or docked into the page
Open state is per tab There when you want it
Row states, Refreshing a single row Live status
Caching Cached across tabs
Stacked pull requests Stacked pull requests (new feature entry)
Pinned rows Pinned rows (new feature entry)

Stacked pull requests and Pinned rows were documented at length but never appeared in the feature list, so they now have an entry of their own.

Notes

  • All prose is preserved verbatim — the 153 non-heading lines of the former deep-dive sections were checked line-for-line against the new file. Former ## headings became #### inside their block.
  • Architecture and Development stay as ordinary sections. They are contributor docs rather than features, so collapsing them behind feature toggles would have buried them.
  • Rendering verified through GitHub's own markdown API: 9 <details>, 9 <summary>, and the tables, lists, and headings inside the blocks all render.
  • Also drops a duplicated scripts/ line in the Architecture tree.

Tom Elliott and others added 3 commits August 14, 2026 15:24
The README carried a short Features list and then eight standalone
sections expanding on those same features, so the detail sat between
a reader and the rest of the docs.

Each feature is now a details/summary block: the summary is the
highlight, and expanding it gives the detail that used to live further
down. Docked mode and Collapsing a dock fold into "Or docked into the
page", Open state is per tab into "There when you want it", Row states
and Refreshing a single row into "Live status", and Caching into
"Cached across tabs". Stacked pull requests and Pinned rows had no
entry in the feature list and now have one.

All prose is preserved verbatim; the former section headings become
h4s inside their block. Architecture and Development stay as ordinary
sections, being contributor docs rather than features.

Also drops a duplicated scripts/ line in the Architecture tree.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7527277b-d3ea-4f0a-8e29-3e163381cb61
The worker answers a search from its cache and only then goes to the
network, so the tab's own request has already resolved while the refresh
it set off is still running. React Query's `isFetching` is false for that
whole window, which left the header spinner and the footer dot dark over
exactly the period they were meant to report on.

`CachedSearchPage.revalidating` already carried this from the worker and
no component read it. Derive activity from it alongside `isFetching`, and
show it as a green hairline over the header's bottom border: the track
pulses to say the work is live and a lighter crest crosses it left to
right to give that a direction. The bar is laid over an edge that is
already there, so starting and stopping never moves the list.

Two things the raw flag cannot do on its own. A refresh answered from a
warm cache is over in tens of milliseconds, so the indicator is held
briefly rather than flickering in and out inside a frame. A revalidation
that fails is only logged in the worker and never broadcast, leaving the
flag set for as long as the page stays cached, so the indicator is also
capped rather than claiming to be busy forever.

The crest lightens the track instead of being a second green on top of
it, which reads as a highlight in both colour modes where another green
only reads as a seam. Reduced motion drops the crest and leaves the line
standing still.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 2546a711-ab42-48a5-80e0-9fed2c9d2828
Report a refresh the worker started on its own
@tmelliottjr

Copy link
Copy Markdown
Owner Author

@copilot resolve the merge conflicts in this pull request

Tom Elliott and others added 2 commits August 14, 2026 19:53
The README carried a short Features list and then eight standalone
sections expanding on those same features, so the detail sat between
a reader and the rest of the docs.

Each feature is now a details/summary block: the summary is the
highlight, and expanding it gives the detail that used to live further
down. Docked mode and Collapsing a dock fold into "Or docked into the
page", Open state is per tab into "There when you want it", Row states
and Refreshing a single row into "Live status", and Caching into
"Cached across tabs". Stacked pull requests and Pinned rows had no
entry in the feature list and now have one.

All prose is preserved verbatim; the former section headings become
h4s inside their block. Architecture and Development stay as ordinary
sections, being contributor docs rather than features.

Also drops a duplicated scripts/ line in the Architecture tree.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: 7527277b-d3ea-4f0a-8e29-3e163381cb61

# Conflicts:
#	README.md

Co-authored-by: tmelliottjr <13594679+tmelliottjr@users.noreply.github.com>
Co-authored-by: tmelliottjr <13594679+tmelliottjr@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants