Packages READMEs and rules #5826
Conversation
* main: (29 commits) Show validation error message as string instead of list (#5808) Updated build-deps command to check if registry is newer than dist to force rebuild (#5825) Upgrade TSQ to latest, testing deployments (#5824) Release 18.0.0-alpha.16 Release @plone/slate 18.0.0-alpha.9 Release @plone/scripts 3.4.0 Release @plone/registry 1.5.1 Release generate-volto 9.0.0-alpha.8 Release @plone/components 2.0.0-alpha.4 Release @plone/client 1.0.0-alpha.13 Several dependencies updates to 18 (#5815) [components] Pass down the Popover context, if any, in Select (#5823) [Components] Improve build, get rid of lodash, renaming Views directory, deps cleaning, upgrade StoryBook and Vite (#5822) Linkcheck thinks `README.md` is `http://README.md`. Bad linkcheck, no… (#5816) Release 18.0.0-alpha.15 Changes to Volto autogenerated types Release @plone/slate 18.0.0-alpha.8 Release @plone/types 1.0.0-alpha.5 Add missing @ in the literal of the prepublish script Release @plone/registry 1.5.0 ...
✅ Deploy Preview for plone-components canceled.
|
✅ Deploy Preview for volto canceled.
|
There was a problem hiding this comment.
I reviewed docs.
- One question to define "ESM"
- Add new files to CI https://github.com/plone/volto/blob/main/.github/workflows/readme-link-check.yml#L23
|
@stevepiercy btw, the extra carriage returns that you are adding, VSCode complains about them: |
|
@stevepiercy same for spaces after the list dashes: |
|
I use MyST primarily, where 4 spaces helps with proper indentation of nested lists, code blocks, and admonitions. There is no standard for Markdown flavors, and we don't require linting Markdown, CommonMark, or GitHub's flavor of Markdown anywhere. |
|
@stevepiercy merging for now, we will continue adding and improving, I'd like to have something there. |
|
@stevepiercy I had this extension, I removed it from my setup: https://github.com/DavidAnson/vscode-markdownlint |
|
@sneridagh I assume you could configure it to silence specific warnings. If it helps you, then use it. I always use my editor's preview feature or build docs to catch mistakes. I have an ingrained habit of using the or or This way I always have consistent indentation of any type of list or nested items. |
No description provided.