Skip to content

Commit

Permalink
Move TypeDoc-related stuff into its own directory
Browse files Browse the repository at this point in the history
I think the docs/ directory is something that’s meant to contain
documentation for direct consumption by users or developers, and not
fragments that need to be glued together with something else to be
useful.
  • Loading branch information
lawrence-forooghian committed Nov 14, 2023
1 parent 869be09 commit 4025132
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,6 @@ jobs:
- name: Upload Documentation
uses: ably/sdk-upload-action@v1
with:
sourcePath: docs/generated
sourcePath: typedoc/generated
githubToken: ${{ secrets.GITHUB_TOKEN }}
artifactName: typedoc
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ npm-debug.log
.tool-versions
build/
react/
docs/generated/
typedoc/generated/
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,6 @@
"sourcemap": "source-map-explorer build/ably.min.js",
"sourcemap:noencryption": "source-map-explorer build/ably.noencryption.min.js",
"modulereport": "node scripts/moduleReport.js",
"docs": "typedoc --entryPoints ably.d.ts --out docs/generated --readme docs/landing-page.md"
"docs": "typedoc --entryPoints ably.d.ts --out typedoc/generated --readme typedoc/landing-page.md"
}
}
File renamed without changes.

0 comments on commit 4025132

Please sign in to comment.