Skip to content

Commit 7af455a

Browse files
rhyslbwclaude
andcommitted
build(docs): output TypeDoc to typedoc/ so docs/ can hold tracked documentation
TypeDoc output moves from ./docs to ./typedoc (typedoc.json, .gitignore, collectCoverage.mjs, post_integration Pages publish_dir) so the gitignored, build-regenerated docs/ tree is freed to hold tracked, human-authored documentation. The published docs site content is unchanged. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 80d3f51 commit 7af455a

4 files changed

Lines changed: 5 additions & 7 deletions

File tree

.github/workflows/post_integration.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ jobs:
3737
uses: peaceiris/actions-gh-pages@v3
3838
with:
3939
github_token: ${{ secrets.GITHUB_TOKEN }}
40-
publish_dir: docs
40+
publish_dir: typedoc

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
package-lock.json
33
coverage
44
node_modules
5-
docs
5+
typedoc
66
.env
77
tsconfig.tsbuildinfo
88
lerna-debug.log

collectCoverage.mjs

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,8 @@ import url from 'url';
44

55
const rootDir = path.dirname(url.fileURLToPath(import.meta.url));
66

7-
const coverageIndexDir = path.join(rootDir, 'docs', 'coverage');
8-
if (!fs.existsSync(coverageIndexDir)) {
9-
fs.mkdirSync(coverageIndexDir);
10-
}
7+
const coverageIndexDir = path.join(rootDir, 'typedoc', 'coverage');
8+
fs.ensureDirSync(coverageIndexDir);
119

1210
const packagesDir = path.join(rootDir, 'packages');
1311
for (const packageName of fs.readdirSync(packagesDir)) {

typedoc.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"out": "./docs",
2+
"out": "./typedoc",
33
"readme": "none",
44
"exclude": [ "**/node_modules/**"],
55
"excludeInternal": true,

0 commit comments

Comments
 (0)