Skip to content

Commit 474bf58

Browse files
Copilothawkeyexl
andauthored
Fix broken content templates link and add generated landing page (#127)
* Initial plan * Add generated landing page for Content Templates section and fix README link Co-authored-by: hawkeyexl <[email protected]> * Fix additional broken /docs/contributing links Co-authored-by: hawkeyexl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: hawkeyexl <[email protected]>
1 parent f94232f commit 474bf58

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

.github/pull_request_template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Closes # Related to #
4444
<!-- Mark items as complete with [x] -->
4545

4646
- [ ] I have signed the [Contributor License Agreement](https://cla-assistant.io/doc-detective/doc-detective.github.io)
47-
- [ ] My changes follow the [contribution guidelines](/docs/contributing/)
48-
- [ ] I have used the appropriate [content template](/docs/contributing/templates/) (if applicable)
47+
- [ ] My changes follow the [contribution guidelines](/docs/contribute/docs)
48+
- [ ] I have used the appropriate [content template](/docs/category/content-templates) (if applicable)
4949
- [ ] All new content files use `.mdx` extension
5050
- [ ] Front matter is included on all new pages
5151
- [ ] Links use absolute paths (e.g., `/docs/page` not `../page`)
@@ -61,6 +61,6 @@ Closes # Related to #
6161

6262
**For reviewers:**
6363

64-
- See [Review Process](/docs/contributing/review-process) for guidelines
64+
- See [Review Process](/docs/contribute/docs/review-process) for guidelines
6565
- Focus on technical accuracy and user value
6666
- Don't block on minor style issues—automation handles those

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Fix typos, broken links, or small issues directly in your browser:
2121
Add examples, troubleshooting tips, or new content:
2222

2323
- Follow our [Standard Contributions Guide](https://doc-detective.com/docs/contribute/docs/standard-contributions)
24-
- Use our [content templates](https://doc-detective.com/docs/contributing/templates/) for structure
24+
- Use our [content templates](https://doc-detective.com/docs/category/content-templates) for structure
2525
- Set up [local development](#local-development) (optional)
2626

2727
### Substantial contributions (30+ minutes)
@@ -71,7 +71,7 @@ npm run serve # Preview production build locally
7171
npm run doc-detective # Run documentation tests
7272
```
7373

74-
**📖 [Full local development guide →](https://doc-detective.com/docs/contributing/local-development)**
74+
**📖 [Full local development guide →](https://doc-detective.com/docs/contribute/docs/local-development)**
7575

7676
## 📝 Documentation structure
7777

@@ -94,7 +94,7 @@ docs/
9494
Doc Detective tests its own documentation! Learn about our testing approach:
9595

9696
- **Run tests**: `npm run doc-detective`
97-
- **Write tests**: See our [Testing Guide](https://doc-detective.com/docs/contributing/testing)
97+
- **Write tests**: See our [Testing Guide](https://doc-detective.com/docs/contribute/docs/testing)
9898
- **Test files**: Look for `.spec.json` files throughout the docs
9999

100100
## 🤔 Questions or ideas?

docs/contribute/docs/templates/tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -426,7 +426,7 @@ Now that you understand the basics:
426426

427427
- [Add more actions to your tests](/docs/category/actions)
428428
- [Learn about test contexts](/docs/get-started/config/contexts/)
429-
- [Write tests for your own documentation](/docs/contributing/testing)
429+
- [Write tests for your own documentation](/docs/contribute/docs/testing)
430430
````
431431
432432
## Checklist before submitting

sidebars.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,11 @@ const sidebars: SidebarsConfig = {
145145
{
146146
type: "category",
147147
label: "Content Templates",
148+
link: {
149+
type: "generated-index",
150+
description:
151+
"Use these templates as starting points when creating new documentation. Each template follows The Good Docs Project guidelines and includes guidance on structure, content, and best practices.",
152+
},
148153
items: [
149154
"contribute/docs/templates/how-to",
150155
"contribute/docs/templates/tutorial",

0 commit comments

Comments
 (0)