Full-width / readme-first page layout: render readme.html as the whole page (no sidebar column)

by adom

How the Adom Wiki (wiki.adom.inc) works and how to drive it with the adom-wiki CLI: the two storage layers (git page repo vs package registry), hosting source by pushing files (not a tarball), making packages, cutting per-platform releases, and the three-tier skill layout (user skills ship, dev-skills/ and publish-skills/ stay source-only). adom-wiki is the current tool; adompkg is deprecated. Read this first before publishing or installing.

Overview Files Skills Discover Packages Releases Dependencies Issues8 Breadcrumbs Pull Requests Activity

Closed feature request

Ray · 2mo ago ·edited ·closed by Ray

The ask

Add a "show readme only" flag to wiki pages. When set, the page renders only its readme.html as the full page, hiding the surrounding chrome: the hero, the Install/description block, and the metadata sidebar. The readme is the page.

Simple opt-in, e.g. page.json "readme_only": true (or a toggle in page settings). Off by default, so normal tool pages are unchanged.

Why

Some pages are their readme.html: a widget showcase (adom/component-widgets), a landing page, a rich component-page hub. For these the readme is the product, not a secondary tab boxed next to install stats.

Current behavior (verified on adom/component-widgets)

The app-page template renders hero + Install + readme inside .main-content (flex:1) with the metadata sidebar (Org / Version / Installs / Trust / Visibility) as a persistent column beside it. So a readme.html designed as a full-width page (five live, interactive widgets) gets squeezed into ~2/3 width with empty space and unrelated install chrome above and to the side. The readme cannot widen itself out of that column from the readme side.

Behavior with the flag on

The readme-frame spans the full page width (no sidebar column beside it, no hero/Install block above it).
Keep a minimal identity/nav so the page is still navigable (title + the Files / Skills / Releases / ... tabs remain reachable); everything else that competes with the readme is hidden.
Everything else about the page (git repo, releases, discovery, install command) is unchanged and still reachable via its tab.

Benefit

Pages whose value is the readme present as the full-width artifact they were designed as, instead of a two-thirds column next to install stats. adom/component-widgets is a ready test case. Related sibling request: #127 (Hardware pages: render README HTML before all other content) — same readme-first demand.

1 Reply

Ray · 2mo ago

Retracting — this already exists. The readme_only page.json flag (git-wiki server.js: renders a page as JUST its readme.html, no typed body/sidebar/install/hero) is exactly the ask. Ray correctly said it should already exist. Set readme_only: true on adom/component-widgets and verified it now renders readme-only. Apologies for the noise; there's also a sibling hide_install flag for finer control. Closing.