Skip to content

docs: create reference index page#7659

Merged
sapphi-red merged 15 commits intomainfrom
12-26-docs_auto-gen
Dec 26, 2025
Merged

docs: create reference index page#7659
sapphi-red merged 15 commits intomainfrom
12-26-docs_auto-gen

Conversation

@mdong1909
Copy link
Collaborator

Before:
image

After:
20251225-2233-14 3291333

refs: #7654

Copilot AI review requested due to automatic review settings December 25, 2025 22:33
@netlify
Copy link

netlify bot commented Dec 25, 2025

Deploy Preview for rolldown-rs ready!

Name Link
🔨 Latest commit f6235b3
🔍 Latest deploy log https://app.netlify.com/projects/rolldown-rs/deploys/694e49b53893fa00080d35be
😎 Deploy Preview https://deploy-preview-7659--rolldown-rs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR creates a new reference index page for Rolldown's documentation that provides a searchable, organized view of all configuration options and APIs. The implementation generates a dynamic index from TypeDoc-generated sidebar JSON files, presenting them in a filterable grid layout.

Key changes:

  • Added a Vue-based API reference index component with search/filter functionality
  • Created a data loader that processes TypeDoc sidebar JSON files into a structured index
  • Updated the reference generation script to replace the auto-generated index with the custom one

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 6 comments.

File Description
docs/.vitepress/theme/components/api.index.md Markdown wrapper page that imports and renders the ApiIndex Vue component
docs/.vitepress/theme/components/api.data.ts VitePress data loader that reads and transforms TypeDoc sidebar JSON files into structured API reference data
docs/.vitepress/theme/components/ApiIndex.vue Vue component implementing the searchable API reference index with grid layout and filtering
docs/.vitepress/scripts/generate-reference.ts Updated to replace the auto-generated reference index with the custom api.index.md file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings December 25, 2025 22:39
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot AI review requested due to automatic review settings December 25, 2025 22:47
mdong1909 and others added 2 commits December 26, 2025 06:49
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copy link
Contributor

Copilot AI commented Dec 25, 2025

@mdong1909 I've opened a new pull request, #7660, to work on those changes. Once the pull request is ready, I'll request review from you.

)

Addresses code review feedback to eliminate duplicated link
transformation logic in `api.data.ts`.

## Changes

- Added `transformLink()` helper function to encapsulate the link
transformation pattern
- Replaced three instances of inline `'/reference' +
item.link.replace('.md', '')` with the helper

**Before:**
```typescript
items: inputOptions.map((item) => ({
  ...item,
  link: '/reference' + item.link.replace('.md', ''),
}))
```

**After:**
```typescript
function transformLink(link: string): string {
  return '/reference' + link.replace('.md', '');
}

items: inputOptions.map((item) => ({
  ...item,
  link: transformLink(item.link),
}))
```

This reduces duplication and centralizes the transformation logic for
easier maintenance.

<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: mdong1909 <[email protected]>
Copilot AI review requested due to automatic review settings December 25, 2025 23:01
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (1)

docs/.vitepress/scripts/generate-reference.ts:30

  • The console.log message 'New index added successfully' is inconsistent with the other log messages that use emoji. For consistency, consider using an emoji prefix like '✅ New index added successfully' or '📄 New index added successfully' to match the style of lines 7 and 9.
  );

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mdong1909 mdong1909 requested a review from sapphi-red December 25, 2025 23:08
@mdong1909 mdong1909 requested a review from hyf0 December 25, 2025 23:08
@mdong1909
Copy link
Collaborator Author

The copilot reviews never stop....

Is this normal?

@hyf0
Copy link
Member

hyf0 commented Dec 26, 2025

The copilot reviews never stop....

Is this normal?

It's fine. Just ignore it.

@hyf0
Copy link
Member

hyf0 commented Dec 26, 2025

Copy link
Member

@hyf0 hyf0 left a comment

Choose a reason for hiding this comment

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

LGTM. I think we could make it work first. @sapphi-red cc

@mdong1909
Copy link
Collaborator Author

As a heads up we'll probably have to update this page after the rebranding to use the new theme

Copilot AI review requested due to automatic review settings December 26, 2025 08:39
@sapphi-red sapphi-red merged commit 6c329ec into main Dec 26, 2025
37 checks passed
@sapphi-red sapphi-red deleted the 12-26-docs_auto-gen branch December 26, 2025 08:41
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@mdong1909
Copy link
Collaborator Author

For my reference, is there a reason this lint action started failing now? Don't think it was before. Is there something I should have done?

https://github.com/rolldown/rolldown/actions/runs/20519364147

@sapphi-red
Copy link
Member

It was fixed by #7669. I think the CI didn't run because the filter was wrong. It should run the lint when the docs are changed.

- name: Lint exports & dependencies
run: pnpm lint-knip

@mdong1909
Copy link
Collaborator Author

Thank you. Was wondering what had changed

This was referenced Dec 31, 2025
shulaoda added a commit that referenced this pull request Dec 31, 2025
## [1.0.0-beta.58] - 2025-12-31

### 💥 BREAKING CHANGES

- experimental/devtools: rename InputOptions#debug to InputOptions#devtools (#7686) by @Copilot

### 🚀 Features

- implement target feature check in `should_transform_js` for raw options (#7697) by @shulaoda
- support `output.dynamicImportInCjs` option (#7677) by @shulaoda
- types: expose `ChecksOptions` type (#7653) by @sapphi-red

### 🐛 Bug Fixes

- export runtime helpers for cross-chunk access (#7658) by @shulaoda
- cjs namespace merging regression (#7665) by @IWANABETHATGUY
- replace panic with proper error handling for hash placeholder generation (#7661) by @shulaoda
- remove the blank line between shebang and postBanner (#7643) by @btea
- rolldown_plugin_vite_reporter: apply padding before ANSI coloring for proper size column alignment (#7649) by @shulaoda

### 🚜 Refactor

- rust: use `StableModuleId` as the map key if possible (#7718) by @hyf0
- rust: return `StableModuleId` instead of `&str` from `Module#stable_id()` (#7717) by @hyf0
- rust: return correct stable id of external module from `Module#stable_id()` (#7716) by @hyf0
- rust: introduce `StableModuleId` type (#7715) by @hyf0
- rust: reduce unnecessary `id.as_arc_str().clone().into()` (#7714) by @hyf0
- rust: remove `ModuleId#resource_id` and use `as_arc_str` directly (#7710) by @hyf0
- rust: remove unused `Module#id_clone` (#7709) by @hyf0
- rust: remove `Module#id_as_str` and use `Module#id` directly (#7708) by @hyf0
- consolidate namespace call analysis into import analyzer (#7657) by @IWANABETHATGUY
- rust: make `ExternalModule#id` have the type `ModuleId` (#7707) by @hyf0
- rust: rename `Module#id` to `Module#id_as_str` (#7706) by @hyf0
- rust: use `ModuleId` instead of raw `ArcStr` for `ScanStageCache` (#7701) by @hyf0
- simplify error propagation in cache merge (#7702) by @shulaoda
- use `ModuleId` as the type of `ResolvedId#id` (#7694) by @hyf0
- types: rename `resolved_request_info.rs` to `resolved_id.rs` and move its contents (#7687) by @hyf0
- devtools: emit data to `<CWD>/node_modules/.rolldown` (#7692) by @hyf0
- use `InvalidOption` for hash placeholder generation errors (#7674) by @shulaoda
- rolldown_error: remove dependency on rolldown_utils (#7672) by @shulaoda
- use nodejs-built-in-modules v1.0.0 directly in callsites (#7667) by @Boshen

### 📚 Documentation

- migrate input options content from options to auto gen docs (#7663) by @mdong1909
- create reference index page (#7659) by @mdong1909
- tweak auto-generated reference output (#7654) by @sapphi-red
- initialize auto-gen docs (#7252) by @mdong1909

### ⚙️ Miscellaneous Tasks

- deps: update napi (#7705) by @renovate[bot]
- pin Node.js version to 24.12.0 LTS in .node-version file (#7713) by @Copilot
- update esbuild test reasons (#7703) by @sapphi-red
- deps: update crate-ci/typos action to v1.40.1 (#7696) by @renovate[bot]
- deps: update oxc to v0.106.0 (#7512) by @renovate[bot]
- js: replace dprint with oxfmt (#7214) by @Boshen
- deps: update dependency oxlint to v1.36.0 (#7691) by @renovate[bot]
- deps: update github-actions (#7679) by @renovate[bot]
- deps: update npm packages (#7680) by @renovate[bot]
- deps: update rust crates (#7678) by @renovate[bot]
- deps: update oxc resolver to v11.16.2 (#7668) by @renovate[bot]
- add API reference files to knip entry points (#7669) by @Copilot
- deps: update notify (#7651) by @sapphi-red
- add `homepage` field to package.json (#7648) by @trivikr
- deps: update oxc resolver to v11.16.1 (#7647) by @renovate[bot]
- deps: update rolldown-plugin-dts to 0.20.0 (#7645) by @shulaoda

Co-authored-by: shulaoda <[email protected]>
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.

4 participants

Comments