Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bug: readme overview duplicates markdown content #3762

Closed
3 tasks done
jeripeierSBB opened this issue Oct 25, 2022 · 4 comments
Closed
3 tasks done

bug: readme overview duplicates markdown content #3762

jeripeierSBB opened this issue Oct 25, 2022 · 4 comments
Assignees
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil

Comments

@jeripeierSBB
Copy link

jeripeierSBB commented Oct 25, 2022

Prerequisites

Stencil Version

2.19.0

Current Behavior

Until now we documented our components in the readme file before the <!-- Auto Generated Below -->.

so possible our readme could look like following:
Bildschirmfoto 2022-10-25 um 08 06 51


Since the 2.19.0 update, stencil automatically generates the following:
Bildschirmfoto 2022-10-25 um 08 07 53

So the sum up, the part until the first title is copied to overview while the other parts remaining only before the auto generated part.

Expected Behavior

No duplication of written lines in readme before auto generated section.

Steps to Reproduce

Write some lines and sections before auto generated code and run build.

Code Reproduction URL

.

Additional Information

As a possible workaround, we can move all the markdown docs into jsdocs of the component. But it's not convenient to write markdown inside a jsdoc block.

Most probably related to: #3635

@ionitron-bot ionitron-bot bot added the triage label Oct 25, 2022
@rwaskiewicz rwaskiewicz self-assigned this Oct 25, 2022
@rwaskiewicz rwaskiewicz changed the title bug: readme docs messed up bug: readme overview duplicates markdown content Oct 25, 2022
@rwaskiewicz
Copy link
Member

Hey @jeripeierSBB 👋

Sorry about that! I was able to confirm that this is indeed a bug that I introduced in #3635. I'm going to take a look at this later today

@rwaskiewicz rwaskiewicz added the Bug: Validated This PR or Issue is verified to be a bug within Stencil label Oct 25, 2022
@ionitron-bot ionitron-bot bot removed the triage label Oct 25, 2022
@rwaskiewicz
Copy link
Member

@jeripeierSBB

I've created a pre-release version of Stencil, v2.19.1-0, which contains #3766, a commit that fixes the issue.

Can you do me a favor and install this version of Stencil and verify this fixes the issue? Afterwards I can release an official v2.19.1 version

@rwaskiewicz rwaskiewicz added the Awaiting Reply This PR or Issue needs a reply from the original reporter. label Oct 25, 2022
@jeripeierSBB
Copy link
Author

@rwaskiewicz You are very fast, thanks a lot!

v2.19.1-0 works as expected in our repo, so for us it seems fixed.

@ionitron-bot ionitron-bot bot removed the Awaiting Reply This PR or Issue needs a reply from the original reporter. label Oct 26, 2022
@rwaskiewicz
Copy link
Member

The fix for this has been officially released under v2.19.1. I'm going to close this issue as a result. Thanks again!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug: Validated This PR or Issue is verified to be a bug within Stencil
Projects
None yet
Development

No branches or pull requests

2 participants