Skip to content

Commit 6c519fb

Browse files
lamngockhuonglamngockhuong
authored
feat: add docs structure (#18)
1 parent 75e243f commit 6c519fb

File tree

5 files changed

+193
-23
lines changed

5 files changed

+193
-23
lines changed

‎docs/app/_meta.js‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
const meta = {
22
index: {
3-
type: "page",
4-
title: "Home",
5-
display: "hidden",
3+
type: 'page',
4+
title: 'Home',
5+
display: 'hidden',
66
},
77
docs: {
8-
type: "page",
9-
title: "Documentation",
8+
type: 'page',
9+
title: 'Documentation',
1010
},
1111
};
1212

‎docs/app/layout.tsx‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
1-
import { Footer, Layout, Navbar } from "nextra-theme-docs";
2-
import { Head } from "nextra/components";
3-
import { getPageMap } from "nextra/page-map";
4-
import "nextra-theme-docs/style.css";
5-
import "./globals.css";
1+
import { Footer, Layout, Navbar } from 'nextra-theme-docs';
2+
import 'nextra-theme-docs/style.css';
3+
import { Head } from 'nextra/components';
4+
import { getPageMap } from 'nextra/page-map';
5+
import './globals.css';
66

77
export const metadata = {
8-
metadataBase: new URL("https://docs-kit.khuong.dev"),
8+
metadataBase: new URL('https://docs-kit.khuong.dev'),
99
title: {
10-
default: "Project Docs Kit - Documentation",
11-
template: "%s - Project Docs Kit",
10+
default: 'Project Docs Kit - Documentation',
11+
template: '%s - Project Docs Kit',
1212
},
1313
description:
14-
"Project Docs Kit: The best way to build a Project Documentation",
15-
applicationName: "Project Docs Kit",
16-
generator: "Next.js",
14+
'Project Docs Kit: The best way to build a Project Documentation',
15+
applicationName: 'Project Docs Kit',
16+
generator: 'Next.js',
1717
appleWebApp: {
18-
title: "Project Docs Kit",
18+
title: 'Project Docs Kit',
1919
},
2020
other: {
21-
"msapplication-TileImage": "/ms-icon-144x144.png",
22-
"msapplication-TileColor": "#fff",
21+
'msapplication-TileImage': '/ms-icon-144x144.png',
22+
'msapplication-TileColor': '#fff',
2323
},
2424
twitter: {
25-
site: "https://docs-kit.khuong.dev",
25+
site: 'https://docs-kit.khuong.dev',
2626
},
2727
};
2828

@@ -35,8 +35,8 @@ export default async function RootLayout({
3535
<Navbar
3636
logo={
3737
<div>
38-
<b>Project Docs Kit</b>{" "}
39-
<span style={{ opacity: "30%" }}>
38+
<b>Project Docs Kit</b>{' '}
39+
<span style={{ opacity: '30%' }}>
4040
The best way to build a Project Documentation
4141
</span>
4242
</div>
@@ -56,7 +56,7 @@ export default async function RootLayout({
5656
<div className="mx-auto px-4 sm:px-6">
5757
<div className="text-center">
5858
<p>
59-
Built with ❤️ {new Date().getFullYear()} by{" "}
59+
Built with ❤️ {new Date().getFullYear()} by{' '}
6060
<a href="https://khuong.dev" target="_blank">
6161
Khuong Dev
6262
</a>

‎docs/content/_meta.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
export default {
22
index: 'Home',
3+
'docs-structure-guide': 'Documentation Structure',
34
introduction: 'Introduction',
45
guides: 'Guides',
56
reference: 'Reference',

‎docs/content/docs-structure-guide.mdx‎

Lines changed: 137 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,137 @@
1+
# Documentation Structure Guide
2+
3+
This guide explains the organization and structure of our project documentation to help you find the information you need quickly and efficiently.
4+
5+
## Documentation Sections
6+
7+
### 1. Introduction
8+
The Introduction section provides a high-level overview of the project:
9+
- Project background and context
10+
- Business case and value proposition
11+
- Key stakeholders and their roles
12+
- Project scope and objectives
13+
- Technology stack overview
14+
- Risk management approach
15+
16+
### 2. Getting Started
17+
The Getting Started section helps new users and developers begin working with the project:
18+
- System requirements and prerequisites
19+
- Installation instructions
20+
- Basic configuration
21+
- First steps and examples
22+
- Common troubleshooting
23+
24+
### 3. User Guide
25+
The User Guide contains detailed information for end-users:
26+
- Features and functionality
27+
- Step-by-step tutorials
28+
- Best practices
29+
- Common use cases
30+
- Tips and tricks
31+
32+
### 4. Developer Guide
33+
The Developer Guide provides technical information for developers:
34+
- Architecture overview
35+
- Development setup
36+
- Coding standards
37+
- Testing procedures
38+
- Deployment guidelines
39+
40+
### 5. API Reference
41+
The API Reference documents all available APIs:
42+
- Endpoint documentation
43+
- Request/response formats
44+
- Authentication
45+
- Error handling
46+
- Rate limiting
47+
48+
### 6. Contributing
49+
The Contributing section guides potential contributors:
50+
- How to contribute
51+
- Code of conduct
52+
- Pull request process
53+
- Development workflow
54+
- Style guides
55+
56+
## Documentation Conventions
57+
58+
### File Naming
59+
- Use kebab-case for file names (e.g., `getting-started.mdx`)
60+
- Use descriptive names that reflect the content
61+
- Keep file names concise but meaningful
62+
63+
### Content Structure
64+
- Start with a clear title
65+
- Use appropriate heading levels (h1, h2, h3, etc.)
66+
- Include a brief introduction
67+
- Break content into logical sections
68+
- Use lists for better readability
69+
- Include code examples where relevant
70+
71+
### Code Examples
72+
- Use syntax highlighting
73+
- Include comments for clarity
74+
- Show both simple and complex examples
75+
- Provide context for the code
76+
77+
### Images and Diagrams
78+
- Use clear, high-quality images
79+
- Include alt text for accessibility
80+
- Place images in the `public/images` directory
81+
- Reference images using relative paths
82+
83+
## Best Practices
84+
85+
1. **Keep it Updated**
86+
- Regularly review and update documentation
87+
- Remove outdated information
88+
- Add new features and changes
89+
90+
2. **Be Clear and Concise**
91+
- Use simple, clear language
92+
- Avoid jargon unless necessary
93+
- Provide examples to illustrate points
94+
95+
3. **Make it Accessible**
96+
- Use proper heading hierarchy
97+
- Include alt text for images
98+
- Ensure good color contrast
99+
- Write clear link text
100+
101+
4. **Include Search Keywords**
102+
- Use relevant terms in headings
103+
- Include common search terms
104+
- Add meta descriptions
105+
106+
## How to Navigate
107+
108+
1. **Using the Sidebar**
109+
- The sidebar provides quick access to all sections
110+
- Use the search function to find specific topics
111+
- Expand/collapse sections as needed
112+
113+
2. **Using Search**
114+
- Use the search bar to find specific information
115+
- Search by keywords, topics, or error messages
116+
- Use quotes for exact phrase matching
117+
118+
3. **Using Links**
119+
- Internal links help navigate between related topics
120+
- External links provide additional resources
121+
- Use the "back to top" link for long pages
122+
123+
## Need Help?
124+
125+
If you can't find what you're looking for:
126+
1. Check the table of contents
127+
2. Use the search function
128+
3. Look in related sections
129+
4. Contact the documentation team
130+
131+
## Feedback
132+
133+
We welcome your feedback to improve our documentation:
134+
- Report issues or errors
135+
- Suggest improvements
136+
- Request new topics
137+
- Share your experience

‎docs/content/introduction/index.mdx‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,40 @@
22

33
Provide a brief overview of the project, its goals and the key stakeholders.
44

5+
## Project Overview
6+
- Project background and context
7+
- Business case and value proposition
8+
- Key stakeholders and their roles
9+
- Project timeline and milestones
10+
511
## Scope
612
Describe the high-level scope of the project.
13+
- In-scope items
14+
- Out-of-scope items
15+
- Project boundaries
16+
- Key assumptions and constraints
717

818
## Objectives
919
List the main objectives and deliverables.
20+
- Primary objectives
21+
- Success criteria
22+
- Key performance indicators (KPIs)
23+
- Expected outcomes
24+
25+
## Project Organization
26+
- Team structure and roles
27+
- Communication channels
28+
- Decision-making process
29+
- Reporting structure
30+
31+
## Technology Stack
32+
- Overview of technologies used
33+
- Development environment
34+
- Infrastructure requirements
35+
- Third-party integrations
36+
37+
## Risk Management
38+
- Key project risks
39+
- Risk mitigation strategies
40+
- Contingency plans
41+
- Change management approach

0 commit comments

Comments
 (0)