Skip to content

chore(docs): ui improvements - #993

Open
avivkeller wants to merge 1 commit into
mainfrom
docs-ui
Open

chore(docs): ui improvements#993
avivkeller wants to merge 1 commit into
mainfrom
docs-ui

Conversation

@avivkeller

Copy link
Copy Markdown
Member

Fixes: #987
Fixes: #988
Fixes: #989
Fixes: #990

Copilot AI review requested due to automatic review settings August 3, 2026 16:22
@avivkeller
avivkeller requested a review from a team as a code owner August 3, 2026 16:22
@cursor

cursor Bot commented Aug 3, 2026

Copy link
Copy Markdown

PR Summary

Low Risk
Changes are documentation and doc-site build configuration only; no runtime generator logic is modified in this diff.

Overview
Documentation format: Generator README.md files (including the large web generator doc) replace configuration markdown tables with typed parameter lists (- \name` {type} …withDefault:` where applicable), matching the API Markdown specification style.

Specification: Removes the long Table of Contents block from docs/specification.md (body sections unchanged).

Doc site (www/doc-kit.config.mjs): Sidebar generator labels drop the word “Generator” (e.g. \web`only). Build **target** addslegacy-json. **pathsToCopy** copies assembled www/content` into the output root for the static site.

Reviewed by Cursor Bugbot for commit 9628d45. Bugbot is set up for automated code reviews on this repo. Configure here.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@vercel

vercel Bot commented Aug 3, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
api-docs-tooling Ready Ready Preview Aug 3, 2026 4:23pm

Request Review

@github-actions

github-actions Bot commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

api-links Generator

Performance estimate (single CI run)

  • Generation time: 30.0% slower (1.00 s → 1.30 s)
  • Peak memory: 0.6% lower (355.88 MB → 353.74 MB)

legacy-html Generator

Performance estimate (single CI run)

  • Generation time: 3.4% slower (19.27 s → 19.92 s)
  • Peak memory: 2.1% lower (2.22 GB → 2.17 GB)

legacy-json Generator

Performance estimate (single CI run)

  • Generation time: 3.0% faster (9.99 s → 9.69 s)
  • Peak memory: 4.7% lower (1.78 GB → 1.69 GB)

llms-txt Generator

Performance estimate (single CI run)

  • Generation time: 1.7% slower (9.05 s → 9.20 s)
  • Peak memory: 0.3% lower (1.72 GB → 1.71 GB)

orama-db Generator

Output size: 1 file changed · net +1.19 KB

File size details
File Main PR Change
orama-db.json 9.03 MB 9.03 MB +1.19 KB (+0.0%)

Performance estimate (single CI run)

  • Generation time: 3.5% faster (8.91 s → 8.60 s)
  • Peak memory: 4.8% lower (1.78 GB → 1.69 GB)

web Generator

Output size: 1 file changed · net -200.00 B

File size details
File Main PR Change
all.html 31.41 MB 31.41 MB -200.00 B (-0.0%)

Performance estimate (single CI run)

  • Generation time: 0.1% faster (86.43 s → 86.33 s)
  • Peak memory: 4.0% lower (4.88 GB → 4.69 GB)

@bmuenzenmeyer bmuenzenmeyer left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome turnaround on this, thanks @avivkeller !

@bmuenzenmeyer

Copy link
Copy Markdown
Contributor

fast track request

@bmuenzenmeyer bmuenzenmeyer added the fast track This PR can land before the typical review time, with a :+1: from collaborators label Aug 3, 2026
@codecov

codecov Bot commented Aug 3, 2026

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.
✅ Project coverage is 89.60%. Comparing base (d3306a2) to head (9628d45).

Files with missing lines Patch % Lines
www/doc-kit.config.mjs 0.00% 4 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #993      +/-   ##
==========================================
- Coverage   89.61%   89.60%   -0.01%     
==========================================
  Files         197      197              
  Lines       18416    18418       +2     
  Branches     1724     1724              
==========================================
  Hits        16503    16503              
- Misses       1906     1908       +2     
  Partials        7        7              

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

fast track This PR can land before the typical review time, with a :+1: from collaborators

Projects

None yet

5 participants