8000 Style the docs site and rewrite the evidence pages by rafatahmed · Pull Request #33 · rafatahmed/Flahax · GitHub
[go: up one dir, main page]
Skip to content

Style the docs site and rewrite the evidence pages - #33

Merged
rafatahmed merged 2 commits into
mainfrom
docs/readthedocs-site
Oct 20, 2026
Merged

Style the docs site and rewrite the evidence pages#33
rafatahmed merged 2 commits into
mainfrom
docs/readthedocs-site

Conversation

@rafatahmed
@rafatahmed rafatahmed commented Oct 20, 2026
Copy link
Copy Markdown
Owner

Follow-up to #32, after reviewing the live site.

Styling and navigation

  • FlahaX mark, green brand colours (light and dark), cleaner headings, compact scrollable tables.
  • Landing page with six "Start here" cards and short badges.
  • Sidebar regrouped (Get started, Planning guides in P0–P3 order, API, Models, Evidence, Project) with short titles; page content unchanged.
  • Copy buttons on code blocks, edit-this-page links, GitHub footer link.
  • New pinned docs dependencies: sphinx-design==0.6.1, sphinx-copybutton==0.5.2.

Evidence pages

  • Computational assessment: explains G6, plain summary of what was and was not accepted, corrects the stale "hosted CI outstanding" statement (met for 0.4.0), notes that later capabilities are outside this assessment.
  • Release evidence: current-status summary and release table at the top, consistent dated headings, stale closing "release decision" replaced with the still-valid gates, file/PR/run references linked.
  • Removed a local user path and credential-store details from the release evidence, and a local path from the Horticalc audit report.
  • New test test_site_has_no_local_user_paths keeps local paths off the site.

Checks

  • python -m sphinx -W --keep-going -b html docs/site builds with no warnings.
  • tests.test_docs_site and tests.test_release_hygiene pass.
  • Checked in light, dark and phone width.

@rafatahmed
Style the docs site and tidy its navigation
41a36df 
Brand mark, colours and table styling on Furo; landing-page cards;
short, ordered sidebar titles; copy buttons, edit links and a GitHub
footer link.
@rafatahmed
Rewrite the evidence pages for public readers
3362b5d 
Add a current-status summary and release table to the release evidence,
mark dated records as historical, correct the stale hosted-CI statements,
link file and PR references, and remove a local path and credential
details. Add a test that keeps local user paths off the site.
@rafatahmed
rafatahmed merged commit e592e21 into main Oct 20, 2026
5 checks passed
@rafatahmed
rafatahmed deleted the docs/readthedocs-site branch October 20, 2026 07:05
@rafatahmed rafatahmed self-assigned this Oct 20, 2026
rafatahmed added a commit that referenced this pull request Nov 7, 2026
@rafatahmed
Merge pull request #33 from rafatahmed/docs/readthedocs-site
d9a7fc7 
Style the docs site and rewrite the evidence pages
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@rafatahmed rafatahmed

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@rafatahmed
0