Skip to content

Commit 256aef3

Browse files
committed
fixed styling of docs
1 parent 26f5ea1 commit 256aef3

File tree

3 files changed

+9
-11
lines changed

3 files changed

+9
-11
lines changed

development/scripts/build-docs.md

-2
Original file line numberDiff line numberDiff line change
@@ -90,5 +90,3 @@ This script appears to be part of a documentation website generation pipeline. I
9090
2. Create a organized navigation structure
9191
3. Add user-friendly navigation controls
9292
4. Support hierarchical documentation with sections and subsections
93-
94-

development/scripts/build-meetings.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
## Build meetings script
22

3-
#### Summary
3+
### Summary
44

55
This script is a Node.js module that interacts with the Google Calendar API to fetch upcoming meetings and writes the data to a specified file path. It uses the Google APIs client library to authenticate and access calendar events. The script is designed to be run as a cron job, fetching events within a specified time range and logging the results. It handles authentication, data fetching, and error management, ensuring that the data structure received from the API is valid before processing.
66

7-
#### Overview
7+
### Overview
88

99
- **Purpose**: Fetch upcoming meetings from Google Calendar and save them to a JSON file.
1010
- **Language**: TypeScript
@@ -14,7 +14,7 @@ This script is a Node.js module that interacts with the Google Calendar API to f
1414
- `path` and `url` for file path manipulations
1515
- A custom logger utility for logging information
1616

17-
#### Key Components
17+
### Key Components
1818

1919
1. **Authentication**:
2020
- Uses `google.auth.GoogleAuth` for OAuth2 authentication.
@@ -35,7 +35,7 @@ This script is a Node.js module that interacts with the Google Calendar API to f
3535
- Writes the processed event data to a specified JSON file.
3636
- Logs the fetched events using a custom logger.
3737

38-
#### Development Setup
38+
### Development Setup
3939

4040
1. **Prerequisites**:
4141
- Node.js and npm installed
@@ -66,7 +66,7 @@ This script is a Node.js module that interacts with the Google Calendar API to f
6666
tsx scripts/build-meetings.ts
6767
```
6868

69-
#### Usage
69+
### Usage
7070

7171
- **Environment Variables**:
7272
- `CALENDAR_SERVICE_ACCOUNT`: JSON string of service account credentials.
@@ -76,17 +76,17 @@ This script is a Node.js module that interacts with the Google Calendar API to f
7676
- The script can be executed directly to fetch and write meeting data to `meetings.json` in the `config` directory.
7777
- It is designed to be run as a cron job at midnight.
7878

79-
#### Command
79+
### Command
8080

8181
To run the script manually, ensure the environment variables are set and execute:
8282

8383
```bash
8484
tsx scripts/build-meetings.ts
8585
```
8686

87-
#### Output
87+
### Output
8888
The output will be a JSON file containing an array of upcoming meetings with details such as title, calendar link, GitHub issue URL, banner, and date. The file will be saved in the specified path (e.g., `../config/meetings.json`).
8989

90-
#### Notes
90+
### Notes
9191
- Ensure that the Google Calendar API is enabled for the project associated with the service account.
9292
- The script is designed to be run in a Node.js environment with TypeScript support.

development/scripts/build-tools.md

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

33
### Overview
44

0 commit comments

Comments
 (0)