Description
The README files published with our @dotcms npm packages contain broken in-page links and missing sections that are referenced in their Tables of Contents. This degrades the developer experience on npmjs.com (where the README is the primary documentation surface) and directly contributes to support tickets.
Confirmed example — @dotcms/client:
The Table of Contents links to a "How to Enable Page Editing" guide:
- [How to Enable Page Editing](#how-to-enable-page-editing)
…but no such section exists in the README. The How-to Guides jump from "How to Work with GraphQL" / "How to Use with TypeScript" straight to "API Reference". The anchor #how-to-enable-page-editing resolves to nothing — a dead link on https://www.npmjs.com/package/@dotcms/client#how-to-enable-page-editing.
This is especially impactful because page editing (UVE / useEditableDotCMSPage) is one of the most important SDK features, and the absence of a documented section leaves developers guessing how to wire up editor support — a recurring source of support cases.
Goal: Audit the READMEs across all published @dotcms npm packages, fix every broken link, and author the missing sections so each README is complete and accurate on npmjs.com.
Packages in scope
| Package |
README source |
@dotcms/client |
core-web/libs/sdk/client/README.md |
@dotcms/react |
core-web/libs/sdk/react/README.md |
@dotcms/angular |
core-web/libs/sdk/angular/README.md |
@dotcms/uve |
core-web/libs/sdk/uve/README.md |
@dotcms/types |
core-web/libs/sdk/types/README.md |
@dotcms/experiments |
core-web/libs/sdk/experiments/README.md |
@dotcms/analytics |
core-web/libs/sdk/analytics/README.md |
@dotcms/create-app |
core-web/libs/sdk/create-app/README.md |
Acceptance Criteria
Priority
Medium
Additional Context
Description
The README files published with our
@dotcmsnpm packages contain broken in-page links and missing sections that are referenced in their Tables of Contents. This degrades the developer experience on npmjs.com (where the README is the primary documentation surface) and directly contributes to support tickets.Confirmed example —
@dotcms/client:The Table of Contents links to a "How to Enable Page Editing" guide:
…but no such section exists in the README. The How-to Guides jump from "How to Work with GraphQL" / "How to Use with TypeScript" straight to "API Reference". The anchor
#how-to-enable-page-editingresolves to nothing — a dead link on https://www.npmjs.com/package/@dotcms/client#how-to-enable-page-editing.This is especially impactful because page editing (UVE /
useEditableDotCMSPage) is one of the most important SDK features, and the absence of a documented section leaves developers guessing how to wire up editor support — a recurring source of support cases.Goal: Audit the READMEs across all published
@dotcmsnpm packages, fix every broken link, and author the missing sections so each README is complete and accurate on npmjs.com.Packages in scope
@dotcms/clientcore-web/libs/sdk/client/README.md@dotcms/reactcore-web/libs/sdk/react/README.md@dotcms/angularcore-web/libs/sdk/angular/README.md@dotcms/uvecore-web/libs/sdk/uve/README.md@dotcms/typescore-web/libs/sdk/types/README.md@dotcms/experimentscore-web/libs/sdk/experiments/README.md@dotcms/analyticscore-web/libs/sdk/analytics/README.md@dotcms/create-appcore-web/libs/sdk/create-app/README.mdAcceptance Criteria
@dotcmsnpm package README is reviewed for broken links and missing sections (table above).@dotcms/client(and any framework package whose TOC references it), coveringclient.page.get()→useEditableDotCMSPage→DotCMSLayoutBody, with a link to the working example atexamples/nextjs.core-web/libs/sdk/*/README.mdsource files (not the generateddist/copies).Priority
Medium
Additional Context
@dotcms/client→#how-to-enable-page-editing(1 broken in-page anchor out of 33 unique anchor links; section missing).src/views/Page.jsusesuseEditableDotCMSPage).