Add version-specific titles to TypeDoc documentation#38
Merged
theroyalwhee0 merged 2 commits intomainfrom Nov 4, 2025
Merged
Conversation
Update documentation workflow to generate different titles for released and unreleased documentation: - Released builds: "CommonProps Documentation - v0.1.2" (with version) - Unreleased builds: "CommonProps Documentation - Unreleased" Implementation: - Pass --name flag to TypeDoc CLI with conditional logic - Pass --includeVersion false to prevent double version suffix - Use existing is_release detection from workflow Testing: - Verified locally with both release and unreleased name formats - Confirmed page titles render correctly in generated HTML Resolves #37
Update API section in README to clearly explain the two documentation versions available: - Latest: Points to most recent stable release documentation - Unreleased: Points to current main branch documentation (may include unreleased features) This helps users understand which documentation version to use based on their needs and clarifies the difference between stable and development documentation.
theroyalwhee0
added
📚 documentation
theroyalwhee0
deleted the
37-add-version-specific-titles-to-typedoc-documentation
branch
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Changes
--nameand--includeVersion falseflags to TypeDocis_releasedetection to conditionally set documentation titleTesting
Tested locally with both formats:
npx typedoc --name "CommonProps Documentation - Unreleased" --includeVersion falsenpx typedoc --name "CommonProps Documentation - v0.1.2" --includeVersion falseBenefits
Resolves #37