Skip to content

Commit 9f5ab63

Browse files
author
abrulic
committed
updated documentation
1 parent 73cfd7f commit 9f5ab63

3 files changed

Lines changed: 6 additions & 72 deletions

File tree

content/02-project-structure.mdx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,6 @@ Template for environment variables:
115115

116116
```env
117117
GITHUB_REPO_URL=https://github.com/your-org/your-repo
118-
GITHUB_BRANCH=main
119118
```
120119

121120
Copy this to `.env` and fill in your values.

content/04-deployment-versioning.mdx

Lines changed: 6 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,6 @@ Add your environment variables to Fly:
4444

4545
```bash
4646
fly secrets set GITHUB_REPO_URL=https://github.com/your-org/your-repo
47-
fly secrets set GITHUB_BRANCH=main
4847
```
4948

5049
### 6. Configure fly.toml
@@ -80,8 +79,8 @@ The template includes workflow files for automatic deployment. You need to place
8079
your-repo/
8180
├── .github/
8281
│ └── workflows/
83-
│ ├── deploy.yml # Main deployment
84-
│ └── deploy-release.yml # Release deployment
82+
│ ├── ci.yml # PR deployment
83+
│ └── publish-documentation.yml # Release deployment
8584
├── docs/
8685
│ └── ...
8786
└── ...
@@ -95,17 +94,6 @@ Add these secrets to your GitHub repository (Settings → Secrets and variables
9594

9695
- `FLY_API_TOKEN` - Your Fly.io API token (get it with `fly tokens create deploy`)
9796

98-
### Deployment Triggers
99-
100-
The template supports two deployment workflows:
101-
102-
1. **Continuous Deployment** (`deploy.yml`)
103-
- Triggers on every push to main branch
104-
- Deploys latest documentation
105-
106-
2. **Release Deployment** (`deploy-release.yml`)
107-
- Triggers when you create a GitHub release
108-
- Generates versioned documentation
10997

11098
## Versioning System
11199

@@ -141,12 +129,12 @@ generated-docs/
141129
pnpm run generate:docs
142130
```
143131

144-
This creates only the `main/` folder with your latest documentation.
132+
This creates only the `latest/` folder with your latest documentation.
145133

146-
#### With Versions (All Releases)
134+
#### With Versions
147135

148136
```bash
149-
pnpm run generate:docs -- --versions
137+
pnpm run generate:docs --versions "semver range or exact tags"
150138
```
151139

152140
This:
@@ -171,58 +159,15 @@ git push origin v1.0.0
171159
4. **Create a GitHub release** from that tag
172160
5. **Automatic deployment** will generate versioned docs
173161

174-
### Including Docs in Release Workflow
175-
176-
To automatically include documentation in your release workflow, modify your `.github/workflows/release.yml`:
177-
178-
```yaml
179-
name: Release
180-
181-
on:
182-
release:
183-
types: [published]
184-
185-
jobs:
186-
deploy-docs:
187-
runs-on: ubuntu-latest
188-
steps:
189-
- uses: actions/checkout@v3
190-
191-
- name: Setup Node.js
192-
uses: actions/setup-node@v3
193-
with:
194-
node-version: '18'
195-
196-
- name: Install dependencies
197-
run: pnpm install
198-
199-
- name: Generate versioned docs
200-
run: pnpm run generate:docs -- --versions
201-
working-directory: ./docs
202-
203-
- name: Deploy to Fly.io
204-
uses: superfly/flyctl-actions/setup-flyctl@master
205-
with:
206-
version: latest
207-
208-
- run: flyctl deploy --remote-only
209-
working-directory: ./docs
210-
env:
211-
FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }}
212-
```
213-
214162
## SEO Configuration
215163

216164
### Robots.txt
217165

218166
By default, the template **prevents indexing** with `x-robots-tag` header. To enable indexing:
219167

220168
1. Remove the header from your CDN/Fly.io configuration
221-
2. Or modify `robots.txt` in the `public/` folder
222-
223-
### Sitemaps
169+
2. Or modify `robots.txt`
224170

225-
Sitemaps are automatically generated for all your documentation pages. They're available at `/sitemap.xml`.
226171

227172
### llms.txt
228173

content/05-customization-tips.mdx

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -312,16 +312,6 @@ content/
312312
└── 03-errors.mdx
313313
```
314314

315-
### Testing
316-
317-
Use Vitest for testing components:
318-
319-
```bash
320-
pnpm test
321-
```
322-
323-
Add tests in `__tests__/` folders alongside your components.
324-
325315
## Troubleshooting
326316

327317
### Content Not Showing

0 commit comments

Comments
 (0)