Skip to content

Commit 9c9dabc

Browse files
authored
Update README.md
1 parent 571f82e commit 9c9dabc

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

src/pages/storage-finder/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ This means **content editors only need to update the Google Sheet** — the next
4242
> [!NOTE]
4343
> The workflow only commits when the generated output differs from what is already in the repository. If the sheet has not changed since the last run, no commit is made.
4444
45-
### Triggering a manual sync
45+
### Triggering a Manual `sync`
4646

4747
If you need changes to appear immediately rather than waiting for Saturday's scheduled run:
4848

@@ -69,7 +69,7 @@ bun scripts/storage-finder-data-generator/generate.ts \
6969

7070
If you do not have Bun installed, get it from [https://bun.sh/](https://bun.sh/), or run the script with `pnpm dlx tsx` instead of `bun`.
7171

72-
### Environment variable
72+
### Environment Variable
7373

7474
The default Google Sheet URL is baked into `scripts/storage-finder-data-generator/constants.ts`. To override it without modifying the source, set the `STORAGE_FINDER_SHEET_URL` environment variable before running the script:
7575

@@ -78,7 +78,7 @@ STORAGE_FINDER_SHEET_URL="https://..." bun scripts/storage-finder-data-generator
7878
--output src/data/storage-finder
7979
```
8080

81-
### CLI flags summary
81+
### CLI Flags Summary
8282

8383
| Flag | Description |
8484
|------|-------------|
@@ -126,18 +126,18 @@ When a service is selected, the following fields appear as rows in the compariso
126126

127127
## Making Changes
128128

129-
### Updating service information
129+
### Updating Service Information
130130

131131
Edit the corresponding row in the Google Sheet, then regenerate the data. Service IDs are automatically generated as URL-safe slugs from the `Title` column. If a title is duplicated, subsequent entries get a numeric suffix (e.g., `my-service-2`).
132132

133-
### Adding a new service
133+
### Adding a New Service
134134

135135
Add a new row to the Google Sheet with a unique value in the `Title` column and fill in all relevant columns. Then regenerate the data.
136136

137137
> [!WARNING]
138138
> Every cell in a row should be filled in accurately. The generator uses regex patterns to map cell text to facet choices. A blank cell causes the generator to apply the fallback behavior for that question (usually matching all choices for that facet, keeping the service visible regardless of what users select for that question).
139139
140-
### Adding or changing a question
140+
### Adding or Changing a Question
141141

142142
1. If the question requires a new signal, add a column to the Google Sheet and populate it for all services.
143143
2. In `scripts/storage-finder-data-generator/config.ts`, add a new entry to the `FACET_CONFIGS` array (or modify an existing one):
@@ -151,7 +151,7 @@ Add a new row to the Google Sheet with a unique value in the `Title` column and
151151
- `allowMultipleMatches: true` — required on radio facets that legitimately match more than one choice
152152
3. Regenerate and verify in the app.
153153

154-
### Adding or changing a service detail field
154+
### Adding or Changing a Service Detail Field
155155

156156
1. Ensure the column exists in the Google Sheet and is populated.
157157
2. In `scripts/storage-finder-data-generator/config.ts`, add or modify an entry in `FIELD_DEFINITIONS`:

0 commit comments

Comments
 (0)