Skip to content

[Documentation]: Point GitHub docs links to webcmd.dev/docs #74

Description

@beubax

Context

The repo already contains Mintlify documentation under docs/, and the public docs are intended to live at https://webcmd.dev/docs. GitHub-facing surfaces should consistently point users to that published documentation site.

Goal

Update the repository's documentation links so users coming from GitHub are directed to https://webcmd.dev/docs as the canonical docs entry point.

Proposed scope

  • Update the top-level README.md to include a prominent docs link to https://webcmd.dev/docs.
  • Check existing links in README.md, CONTRIBUTING.md, package metadata, and docs index pages for stale or local-only docs references.
  • Ensure the Mintlify docs source in docs/ still works as the canonical source for the published site.
  • If appropriate, update repository metadata/homepage settings to point at the docs site or product site.

Acceptance criteria

  • GitHub users can easily find https://webcmd.dev/docs from the README.
  • Stale documentation URLs are replaced or redirected to the published Mintlify docs location.
  • The docs source remains in docs/ and continues to build for Mintlify.
  • Contributors understand that changes to docs should be made in the repo and published to webcmd.dev/docs.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Fields

No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions