Skip to content

Sync docs from README.md to docs/*.md#3116

Closed
azz wants to merge 6 commits intoprettier:masterfrom
azz:sync-docs-2
Closed

Sync docs from README.md to docs/*.md#3116
azz wants to merge 6 commits intoprettier:masterfrom
azz:sync-docs-2

Conversation

@azz
Copy link
Member

@azz azz commented Oct 29, 2017

This is a lower-tech variant of #2825.

  • Copies content from the main README.md file to the docs directory using markdown-magic.
  • Validated in CI via git diff.
  • Replaces existing markdown-toc with markdown-magic

Closes #2825
Supersedes #2937

@azz
Copy link
Member Author

azz commented Oct 29, 2017

Thoughts on whether we should generate from README.md to docs/ or the other way around? Usually build steps are compositional rather than extracting bits, but people landing on the repo will probably submit edits to README and it would be strange to have part of that file generated, half hand-written.

I've redirected the EDIT THIS DOC buttons on the website to the README.md so we don't get people accidentally submitting changes to the docs files.

@duailibe
Copy link
Collaborator

Or maybe we should not have so much info in the README and link to docs instead? I know this might be controversial but I think it’s more sane

@azz
Copy link
Member Author

azz commented Oct 29, 2017

Yeah that's also an option. We'd have to make sure everything in the README is covered elsewhere though. Babel's README works like this.

package.json Outdated
"jest-docblock": "21.3.0-beta.1",
"jest-validate": "21.1.0",
"leven": "2.1.0",
"markdown-magic": "^0.1.19",
Copy link
Member

Choose a reason for hiding this comment

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

pin?

Copy link
Member Author

Choose a reason for hiding this comment

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

Gah, I keep doing this. Need to figure out why my yarn isn't respecting .yarnrc.

@azz
Copy link
Member Author

azz commented Nov 2, 2017

@vjeux thoughts on this vs just redirecting from Readme to website and building that out more?

@vjeux
Copy link
Contributor

vjeux commented Nov 2, 2017

I don't feel strongly about the two variants. Either we redirect to the website or we make sure the two are kept in sync.

@azz azz mentioned this pull request Nov 3, 2017
@azz
Copy link
Member Author

azz commented Nov 3, 2017

Seems more sane to only keep the docs in one place. Better for maintenance and contribution via GitHub (without needing to run build tools). Opened #3139

@azz azz closed this Nov 3, 2017
@lock lock bot added the locked-due-to-inactivity Please open a new issue and fill out the template instead of commenting. label Jan 19, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Jan 19, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

locked-due-to-inactivity Please open a new issue and fill out the template instead of commenting.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants