docs: improve typedocs — clean rebase of #2563#2957
Open
Chase Poirier (chasepoirier) wants to merge 44 commits intomasterfrom
Open
docs: improve typedocs — clean rebase of #2563#2957Chase Poirier (chasepoirier) wants to merge 44 commits intomasterfrom
Chase Poirier (chasepoirier) wants to merge 44 commits intomasterfrom
Conversation
* refactor: remove entities barrels file to improve import structure and help with docs generation * refactor: ensure export types barrel file is used to export types only * refactor: rename plain/common-types to actually describe what the file contains * fix: remove confusing outdated ClientParams type and finally export the type for the client creation options * refactor: rename params to clientOptions in createClient function to ensure naming of variable matches naming of type * refactor: remove deprecated, unsupported and unused alphaFeatures * style: remove outdated ts-error comments and add details to still valid ones * refactor: rename DefaultParams to PlainClientDefaultParams to avoid confusion with legacy client params * fix: restore non-enumerable toPlainObject compatibility and __VERSION__ ts-expect-error after rebase * refactor: standardize @private/@internal convention and tag internal types - Add @internal to ~80 internal Params types in common-types.ts - Switch exported-but-internal symbols from @Private to @internal (MakeRequest, MRActions, MROpts, MRReturn, XOR, WrapParams, WrapFn, wrap, createPlainClient, all create-*-api types and functions) - Add missing @internal to environment template API type and function - Fix OptionalDefaults: remove incorrect @Private, add proper JSDoc - Mark deprecated type aliases in export-types.ts (AccessTokenProp, CreatePATProps, UIExtension, UIExtensionProps, CreateUIExtensionProps) * refactor: standardize API type naming (Api -> API) and fix duplicate name - Rename ContentfulEntryApi to ContentfulEntryAPI - Rename ContentfulEnvironmentTemplateApi to ContentfulEnvironmentTemplateAPI - Rename ContentfulUIConfigApi to ContentfulUIConfigAPI (create-ui-config-api.ts) - Rename ContentfulUIConfigApi to ContentfulUserUIConfigAPI (create-user-ui-config-api.ts), fixing duplicate type name bug * chore: update migration doc with breaking changes * style: use @returns instead of @return across all JSDoc comments to match TypeDoc standard * refactor: standardize all @Private tags to @internal across codebase --------- Co-authored-by: Chase Poirier <chase.poirier@contentful.com>
…d help with docs generation
…ensure naming of variable matches naming of type
…onfusion with legacy client params
…name
- Rename ContentfulEntryApi to ContentfulEntryAPI
- Rename ContentfulEnvironmentTemplateApi to ContentfulEnvironmentTemplateAPI
- Rename ContentfulUIConfigApi to ContentfulUIConfigAPI (create-ui-config-api.ts)
- Rename ContentfulUIConfigApi to ContentfulUserUIConfigAPI
(create-user-ui-config-api.ts), fixing duplicate type name bug
…d help with docs generation
…to use it and make compatible with typedoc
… update gitignore comment
…roken links, example format
…ructure router, and favicon
…le with examples in our typedocs
…links from hostedBaseUrl
|
Bito Automatic Review Skipped - Large PR |
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| var newVersion = select.value | ||
| var subPath = pathSegments.slice(cmIdx + 2).join('/') | ||
| var newUrl = docsBase + '/' + newVersion + '/' + subPath | ||
| window.location.href = newUrl |
Check failure
Code scanning / CodeQL
DOM text reinterpreted as HTML High documentation
Copilot Autofix
AI about 1 month ago
Copilot could not generate an autofix suggestion
Copilot could not generate an autofix suggestion for this alert. Try pushing a new commit or if the problem persists contact support.
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
3 participants
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
Clean rebase of #2563 (
refactor/docs) onto currentmaster. The original PR accumulated 1,800+ commits due to a bad rebase that replayed the entire repo history. This branch contains only the 43 actual commits (39 from Benedikt Rötsch (@axe312ger) + 4 fixups for imports lost during conflict resolution).What this PR does:
typedoc.config.mjs)@module,@category, and@internaltags across all entity filesexcludePrivate/excludeInternalfor cleaner generated docsBefore vs after:
Fixup commits (4): Restored imports/exports that were lost when
--strategy-option=theirsresolved cherry-pick conflicts —AgentResumeRunPayload,wrapAgentGenerateResponse,wrapSpaceAddOnCollection, and a duplicate import block.Supersedes #2563.
Test plan
npm run buildpasses locallynpm run docs:build) produces correct output🤖 Generated with Claude Code
Co-Authored-By: Claude Opus 4.6 (1M context) noreply@anthropic.com