Skip to content

Commit dbc1ee3

Browse files
committed
added nitpick changes
1 parent d26e98c commit dbc1ee3

File tree

5 files changed

+27
-16
lines changed

5 files changed

+27
-16
lines changed

development/scripts/build-docs.md

+22-11
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The `build-docs.ts` script is responsible for generating and managing the docume
1818

1919
## Workflow
2020

21-
1. Build hierarchical navigation tree from flat items using `buildNavTree()`
21+
1. Build a hierarchical navigation tree from flat items using `buildNavTree()`
2222
- Sort items by section type and weight
2323
- Create root sections, subsections, and document pages
2424
- Handle special cases like specification references
@@ -60,20 +60,31 @@ Simple structure containing navigation link information:
6060
- `href`: URL link
6161

6262
## Special Features
63-
- Special handling for the welcome page at /docs
63+
- Special handling for the welcome page at `/docs`
6464
- Reference/specification section with automatic linking to latest specification version
6565
- Weight-based sorting for proper ordering of sections and documents
6666
- Root sections and subsections are marked differently than content pages
6767
- Handles navigation between document sections with smart previous/next links
6868
- Error handling with detailed error messages
6969

70-
## Command
71-
72-
To run the script manually, execute:
73-
74-
```bash
75-
tsx scripts/build-docs.ts
76-
```
70+
## Development Setup
71+
1. **Prerequisites**:
72+
- Node.js and npm installed
73+
- TypeScript installed globally or as a dev dependency
74+
- Access to the project repository
75+
2. **Installing Dependencies**:
76+
```bash
77+
npm install
78+
```
79+
3. **Running the Script**:
80+
- Ensure the environment variables are set.
81+
- Execute the script using:
82+
```bash
83+
tsx scripts/build-docs.ts
84+
```
85+
4. **Output**:
86+
- The output will be a JSON file containing the hierarchical navigation structure and an array of document pages with their respective navigation controls.
87+
- The file will be saved in the specified path (e.g., `../config/posts.json`).
7788

7889
## Output
7990
The output will be a JSON file containing the hierarchical navigation structure and an array of document pages with their respective navigation controls. The file will be saved in the specified path (e.g., `../config/posts.json`).
@@ -84,9 +95,9 @@ No environment variables are required for this script.
8495

8596
## Usage Context
8697

87-
This script appears to be part of a documentation website generation pipeline. It's designed to:
98+
This script is part of a documentation website generation pipeline. It's designed to:
8899
89100
1. Parse raw documentation items
90-
2. Create a organized navigation structure
101+
2. Create an organized navigation structure
91102
3. Add user-friendly navigation controls
92103
4. Support hierarchical documentation with sections and subsections

development/scripts/build-meetings.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ This script is a Node.js module that interacts with the Google Calendar API to f
5656
5757
4. **Installing Dependencies**:
5858
```bash
59-
npm install
59+
npm install
6060
```
6161

6262
5. **Running the Script**:

development/scripts/build-newsroom-videos.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ This script is a Node.js module that interacts with the YouTube Data API to fetc
7979

8080
- **Execution**:
8181
- When run directly, the script writes to `../config/newsroom_videos.json`.
82-
- Can be imported and used as a module with a custom write path.
82+
- It can be imported and used as a module with a custom write path.
8383

8484
### Example Command
8585

development/scripts/build-pages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ This TypeScript script transforms markdown files into MDX files suitable for a R
5151

5252
#### `ensureDirectoryExists(directory: PathLike)`
5353
- Checks if a directory exists and creates it if it doesn't
54-
- Used to ensure the target directory exists before processing
54+
- Ensures that the target directory exists before processing
5555
5656
#### `capitalizeJsxTags(content: string): string`
5757
- Transforms HTML tags to capitalized JSX component tags

development/scripts/build-tools.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Tools Build Script Documentation
1+
## Build Tools Script Documentation
22

33
### Overview
44

@@ -59,7 +59,7 @@ The script generates the following files in the `config` directory:
5959

6060
4. **Environment Configuration**
6161
- Create a `.env` file in the project root with the following variables:
62-
```
62+
```bash
6363
GITHUB_TOKEN='{your-github-token}'
6464
```
6565
- Alternatively, set these variables in your shell environment.

0 commit comments

Comments
 (0)