Skip to content

feat: improve general UI and new docs - #9

Open
pencilnav wants to merge 86 commits into
mainfrom
feat/native-docs
Open

pencilnav wants to merge 86 commits into
mainfrom
feat/native-docs

Conversation

@pencilnav

Copy link
Copy Markdown
Member

this PR aims to replace the current docs site which was created with mkdocs-material (EOL)

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Dec 1, 2025 •

Copy link
Copy Markdown

Deploying atlas-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: c19638e
Status: ✅  Deploy successful!
Preview URL: https://1232788d.atlas-website-bcj.pages.dev
Branch Preview URL: https://feat-native-docs.atlas-website-bcj.pages.dev

View logs

…nhance build process with post-compression script
…ate descriptions, and improve consistency across various sections
…ependencies, and add Wrangler configuration for deployment
…tignore, and enhance caching headers for assets
… and DownloadModal components to utilize these constants
…t colors, stroke widths, and layout adjustments for better visual consistency
…oudflare Workers, including setup for Bun, caching, and deployment steps
…kers, upgrading actions to latest versions and adding Node.js setup
jacksyrm added 30 commits June 26, 2026 12:51
Add a quiet end-of-page homepage note, a Maintenance docs page
with tool recommendations, FAQ entries on the AtlasOS and eclean
relationship, a System Information entry, and a footer link.
Dependencies
- Astro 7.1 -> 7.3, @astrojs/mdx 7 -> 8, markdown-remark 7.3, satori 0.33,
  astro-icon 1.2, wrangler 4.133, ESLint/TypeScript-ESLint/Prettier updates
- Remove jampack (unmaintained; every optimisation it ran was disabled)
- Astro config moved to astro.config.ts with defaults stripped, the tsconfig
  path alias reused instead of a duplicate Vite alias, and the astro-icon
  include list dropped (only needed for server output)
- Enable contentIntellisense and SVG optimisation

Docs navigation
- Replace utils/navigation/* and docs-content.ts with a single cached
  utils/docs.ts (tree, pagination, breadcrumbs, route helpers)
- Section order now comes from frontmatter only; SECTION_PRIORITIES removed
- Sidebar active state driven by aria-current and CSS instead of class toggles
- Pagefind indexes docs pages only

Client scripts
- Restore scroll reveal animations: the motion-ready gate was removed in
  February so every data-animate element rendered without its reveal
- Shared page-lifecycle helper (AbortSignal per navigation) for all scripts
- One clipboard utility for Markdown and CodeBlock copy buttons
- Deterministic Tabs ids (build output no longer changes on every build)
- Slideshow now re-initialises after client-side navigation
- Download modal, navbar and hero clean up listeners between pages
- Spotlight uses astro:transitions/client navigate and drops !important CSS

Worker
- Bindings typed via wrangler types (worker-configuration.d.ts, generated on
  install) with a dedicated tsconfig.worker.json checked in CI
- Simplified request routing, JSON helpers and Browser Rendering flow

Misc
- SEO emits a single JSON-LD @graph; SoftwareApplication on the homepage
- Remove unused components (Badge, Card, Link, LinkCard, Picture,
  SoftwareCard) and the unused Callout dismiss feature
- ESLint config uses defineConfig/globalIgnores; CI checks formatting
- Codebase formatted with prettier-plugin-astro 1.0
Structure
- Page title now rendered by DocsLayout from frontmatter; every docs page
  moved its Markdown h1 into `title` with the short sidebar name kept as
  `sidebar.label`. Fixes the Installation FAQ having no visible title.
- Inline "On this page" disclosure at the top of the article below the xl
  breakpoint, where the fixed table of contents is hidden.
- Search results show the matching section and a highlighted excerpt and
  open the section anchor; the first result is preselected for Enter.

Readability
- Article measure capped at 44rem (about 75 characters per line).
- Fonts switch from display: optional to swap so Inter, Archivo and Fira
  Code render on cold loads; Astro's metric-matched fallbacks avoid shift.
- New --color-link token (lighter blue) for links, active tabs, callout
  accents and inline code; muted/secondary text tokens raised. All
  navigation text now measures Lc 60+ (APCA) on the dark surfaces.

Fixes
- Missing spaces after inline labels in the Windows setup tabs.
- Ask AI button no longer floats above the search dialog, mobile sidebar
  or the table-of-contents utilities.
- Spotlight input no longer draws a second focus ring inside the dialog.
- Table of contents active state uses aria-current; copy-link button
  shares the clipboard utility.
…ero intro

Delays were hard-coded per element in the markup, so a lower card with a
small delay could appear before a higher card with a larger one, and the
hero title and wallpaper never animated while the badge and buttons waited
up to 1.6s.

- Stagger is now decided at reveal time: elements entering the viewport in
  the same observer pass are ordered top-to-bottom, left-to-right and given
  incremental delays (capped at 5 steps); later arrivals start immediately.
- Removed every data-animate-delay attribute from the homepage sections.
- Hero title, lead paragraph and wallpaper join the intro sequence; the
  wallpaper uses an opacity/translate-only reveal (no blur) to keep the
  largest paint cheap. Hero timing tightened to 700ms / 110ms steps.
…wn endpoints

Navigation
- Sidebar sections collapse; only the section holding the current page opens
  by default and choices are remembered for the session (sessionStorage).
  Collapse animates through a grid track so any list height works.
- Nested lists hang off a hierarchy rail and the active page lights up its
  segment; the table of contents gets the same rail behind its marker.

Search
- Results are grouped under their docs section, in sidebar order, with a
  non-focusable heading row per group.

Page actions (below the article)
- Edit this page on GitHub, Copy page as Markdown, Open in ChatGPT, Open in
  Claude.

Markdown for agents
- Every docs page is also served at /docs/<path>.md (imports stripped,
  title/description/source prepended) and /llms.txt indexes them all.
  The content loader now retains bodies to make this possible.

Media
- New Figure component with a gradient hairline frame and caption; plain
  Markdown screenshots get a consistent two-ring frame.
…a Markdown link

Collapsing every section on landing hid the map of the docs. Sections now
start open (nested groups still open only when entered) and collapsing is
remembered per session. The page actions row keeps Edit this page on
GitHub and adds View as Markdown; the ChatGPT/Claude/copy buttons are gone.
The .md endpoints and /llms.txt remain for AI discoverability.
…s; tidy list copy

The table of contents was fixed to the viewport edge while the article sat
in a centred container, so the two drifted apart as the screen widened
(about 700px of empty space at 2000px). The article and TOC are now one
centred grid unit with the TOC sticky inside its column; the column is
always reserved from xl so the article never shifts between pages.

Content: bold list lead-ins across the docs used four different separators
(colon, hyphen, en dash, em dash); all 113 now use a colon. Removed the
line that repeated the heading on the requirements page.
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