Skip to content

docs(docs-readme): document overwriteExisting configuration options#1521

Merged
christian-bromann merged 2 commits intostenciljs:mainfrom
smorrisods:fix/docs-readme-control-readme-overwrite-behaviour
May 5, 2025
Merged

docs(docs-readme): document overwriteExisting configuration options#1521
christian-bromann merged 2 commits intostenciljs:mainfrom
smorrisods:fix/docs-readme-control-readme-overwrite-behaviour

Conversation

@smorrisods
Copy link
Copy Markdown
Contributor

This is a documentation update for the changes in stenciljs/core#6249 and come out of stenciljs/core#6248.

It adds documentation for the overwriteExisting property on the docs-readme output target,
including available options, their behaviours, and an example use case.

…nd usage

Adds documentation for the `overwriteExisting` property on the `docs-readme` output target,
including available options, their behaviours, and an example use case.

Clarifies that the component's README is treated as the canonical source
of truth for custom content.

Related to stenciljs/core#6248.
@vercel
Copy link
Copy Markdown

vercel bot commented May 2, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
stencil-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 5, 2025 6:45pm

@smorrisods smorrisods changed the title docs(docs-readme): document overwriteExisting configuration options a… docs(docs-readme): document overwriteExisting configuration options May 2, 2025
Copy link
Copy Markdown
Member

@christian-bromann christian-bromann left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@christian-bromann christian-bromann merged commit 1856781 into stenciljs:main May 5, 2025
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants