Add Support for Versioning In Docs #1170
Open
+1,576
−144
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Remove all versioning-related documentation files - Remove versioned docs directory (v4.29.0/) - Remove versioning config files (.typedoc-plugin-versions, versions.js) - Remove version symlinks (dev, stable, v4.29) - Restore docs folder to exactly match master branch state
developerkunal
force-pushed
the
update-docs-to-multi-versioning
branch
from
0785435 to
f8788cf
Compare
subhankarmaiti
requested changes
Sep 5, 2025
.github/workflows/docs.yml
Outdated
Comment on lines
24
to
30
| mkdir -p ./docs | ||
| if [ -d "./docs" ] && [ "$(ls -A ./docs)" ]; then | ||
| tar -cvf documentation.tar ./docs | ||
| else | ||
| # Create empty tar if no existing docs | ||
| tar -cvf documentation.tar --files-from /dev/null | ||
| fi |
There was a problem hiding this comment.
as you are in gh-pages, there woun't be any docs folder. you should you root ./ instead of the doc when creating the tar file
There was a problem hiding this comment.
Can you check now
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new GitHub Actions workflow for publishing documentation and adds a version tracking file for documentation builds. The workflow automates building, archiving, and publishing documentation to the
gh-pagesbranch, while the new file tracks available documentation versions.Documentation publishing workflow:
.github/workflows/docs.ymlto automate the process of building, archiving, and publishing documentation to thegh-pagesbranch on release or manual triggers. This workflow handles previous documentation history, builds new docs, and commits updates only if there are changes.Documentation version tracking:
docs/.typedoc-plugin-versionsto track the current documentation version (v4.29.0) and mark it as stable.