Skip to content

Commit 2e26a3c

Browse files
docs-botCopilotheiskrCopilot
authored
Markdown freshness: fix stale path references in src README files (#62963)
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 0501799 commit 2e26a3c

3 files changed

Lines changed: 8 additions & 8 deletions

File tree

src/events/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,5 +143,5 @@ Survey responses with comments are analyzed for sentiment:
143143

144144
- Validation errors appear in server logs
145145
- Production validation errors sent to Hydro for tracking
146-
- Use `analyze-comment-cli.ts` to test sentiment analysis locally
146+
- Use `scripts/analyze-comment-cli.ts` to test sentiment analysis locally
147147

src/redirects/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,11 @@ Read on for more about how redirects work under the hood.
1212

1313
Precompiled redirects account for the majority of the docs site's redirect handling.
1414

15-
When [`lib/warm-server.ts`](lib/warm-server.ts) runs on server start, it creates all pages in the site by instantiating the [`Page` class](lib/page.ts) for each content file, then passes the pages to `lib/redirects/precompile.ts` to create redirects. The precompile script runs `lib/redirects/permalinks.ts`, which:
15+
When [`src/frame/lib/warm-server.ts`](../frame/lib/warm-server.ts) runs on server start, it creates all pages in the site by instantiating the [`Page` class](../frame/lib/page.ts) for each content file, then passes the pages to `lib/precompile.ts` to create redirects. The precompile script runs `lib/permalinks.ts`, which:
1616

17-
1. Includes all legacy redirects from `static/developerjson`
17+
1. Includes all legacy redirects from `lib/static/developer.json`
1818
2. Loops over each page's [frontmatter `redirect_from` entries](content/README.md#redirect_from) and creates an array of legacy paths for each one (using the same handling as for permalinks).
19-
3. Any other exceptions from the `static/redirect-exceptions.txt` file
19+
3. Any other exceptions from the `lib/static/redirect-exceptions.txt` file
2020

2121
The results comprise the `page.redirects` object, whose keys are always only the path without language.
2222
Sometimes it contains the specific plan/version (e.g. `/enterprise-server@3.0/v3/integrations` to `enterprise-server@3.0/developers/apps`) and sometimes it's just the plain path
@@ -44,11 +44,11 @@ Some background on archival: a snapshot of the HTML files for each deprecated En
4444

4545
Starting with Enterprise Server 2.18, we updated the archival process to start preserving frontmatter and permalink redirects. But these redirects for 2.13 to 2.17 are not recoverable.
4646

47-
As a workaround for these lost redirects, we have two files in `lib/redirects/static`:
47+
As a workaround for these lost redirects, we have two files in `lib/static`:
4848

4949
* `archived-redirects-from-213-to-217.json`
5050

51-
This file contains keys equal to old routes and values equal to new routes (aka snapshots of permalinks at the time) for versions 2.13 to 2.17. (The old routes were generated via `lib/redirects/get-old-paths-from-permalink.ts`.)
51+
This file contains keys equal to old routes and values equal to new routes (aka snapshots of permalinks at the time) for versions 2.13 to 2.17. (The old routes were generated via `lib/permalinks.ts`.)
5252

5353
* `archived-frontmatter-valid-urls.json`
5454

@@ -66,7 +66,7 @@ Here's how the `src/archives/middleware/archived-enterprise-versions.ts` fallbac
6666

6767
## Tests
6868

69-
Redirect tests are mainly found in `tests/routing/*`, with some additional tests in `tests/rendering/server.ts`.
69+
Redirect tests are mainly found in `tests/routing/*`, with some additional tests in `src/frame/tests/server.ts`.
7070

7171
The `src/fixtures/fixtures/*` directory includes `developer-redirects.json`, `graphql-redirects.json`, and `rest-redirects.json`.
7272

src/tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -225,7 +225,7 @@ npm run lint
225225

226226
Tests should be co-located with their subject:
227227
-`src/search/tests/api-search.ts`
228-
-`src/versions/tests/middleware.ts`
228+
-`src/events/tests/middleware.ts`
229229
-`src/tests/search-tests.ts` (wrong - not in subject)
230230

231231
Shared utilities belong in `src/tests/`:

0 commit comments

Comments
 (0)