Skip to content

SDK: Audit and fix broken links + missing sections in @dotcms npm package READMEs #36100

Description

@rjvelazco

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

  • Every published @dotcms npm package README is reviewed for broken links and missing sections (table above).
  • All in-page anchor links (Table of Contents → headings) resolve to a real heading — no dead anchors.
  • All external links (docs, GitHub, examples, pricing, etc.) return a valid (non-404) response.
  • The missing "How to Enable Page Editing" section is authored in @dotcms/client (and any framework package whose TOC references it), covering client.page.get()useEditableDotCMSPageDotCMSLayoutBody, with a link to the working example at examples/nextjs.
  • Any other missing sections referenced in a TOC are authored with real content (not left as dead links or empty stubs).
  • READMEs are verified as they render on npmjs.com (or a local markdown preview matching GitHub/npm rendering), not just in-repo.
  • Changes are made in the core-web/libs/sdk/*/README.md source files (not the generated dist/ copies).

Priority

Medium

Additional Context

Metadata

Metadata

Assignees

No one assigned

    Type

    Fields

    No fields configured for Task.

    Projects

    Status
    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions