Skip to content

Commit 136a33f

Browse files
committed
refactor(create-rstack): simplify documentation template
1 parent a77bb5d commit 136a33f

5 files changed

Lines changed: 5 additions & 60 deletions

File tree

packages/create-rstack/template-doc-basic/AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88

99
## Docs
1010

11+
- Rstack: https://rstack.rs/llms.txt
1112
- Rspress: https://rspress.rs/llms.txt
1213
- Rsbuild: https://rsbuild.rs/llms.txt
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
["introduction", "getting-started"]
1+
["introduction"]

packages/create-rstack/template-doc-basic/docs/guide/start/getting-started.md

Lines changed: 0 additions & 46 deletions
This file was deleted.
Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
# Introduction
22

3-
Rspress is a static site generator based on [Rsbuild](https://rsbuild.rs/), rendered with the React framework. It comes with a default documentation theme, and you can quickly build a documentation site with Rspress.
3+
Rspress is a fast static site generator based on [Rsbuild](https://rsbuild.rs/). It supports Markdown and MDX and includes a default documentation theme.
44

5-
## Why Rspress
6-
7-
- **Build Performance**. The core compilation module is based on the Rust front-end toolchain, providing millisecond-level startup and a more ultimate development experience.
8-
- **AI-native**. Technical documentation not only serves human readers but can also be better understood and utilized by AI through SSG-MD.
9-
- **MDX Support**. MDX is a powerful way to write content, allowing you to use React components in Markdown.
10-
- **Basic Capabilities**. Including full-text search, internationalization, multi-version support, component library documentation, etc.
11-
- **Extensibility**. Provides a built-in plugin system, supports extending Rspress through plugin API.
12-
13-
## Try Rspress
14-
15-
Go to [Getting Started](/guide/start/getting-started) to learn how to use Rspress to build a documentation site.
5+
Learn more in the [Rspress documentation](https://rspress.rs/).

packages/create-rstack/tests/create.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ test('creates the doc-basic template', async () => {
132132
await expect(access(path.join(projectDirectory, 'tsconfig.json'))).resolves.toBeUndefined();
133133
await expect(access(path.join(projectDirectory, 'docs', 'index.md'))).resolves.toBeUndefined();
134134
await expect(
135-
access(path.join(projectDirectory, 'docs', 'guide', 'start', 'getting-started.md')),
135+
access(path.join(projectDirectory, 'docs', 'guide', 'start', 'introduction.md')),
136136
).resolves.toBeUndefined();
137137
});
138138

0 commit comments

Comments
 (0)