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.

Sign up for GitHub

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

Jump to bottom

Convert most of the README to links in the documentation #85

Closed
choldgraf opened this issue Feb 27, 2020 · 2 comments
Closed

Convert most of the README to links in the documentation #85

choldgraf opened this issue Feb 27, 2020 · 2 comments
Labels
discussion no fixed close condition documentation Improvements or additions to documentation

Comments

@choldgraf
Copy link
Member

What do people think about converting much of the README into links to places in the documentation? This could help us cut-back on duplicated content that may be hard to remember to update.

I think basic "install and usage" stuff is fine in the README, but other stuff like supported syntax would be better to have in a single canonical place.

Another option would be to use include statements in our documentation and pull from the README.
@choldgraf choldgraf added discussion no fixed close condition documentation Improvements or additions to documentation labels Feb 27, 2020
@chrisjsewell
Copy link
Member

Yep agree. I don't fancy the include route, just seems to 'fiddly'

chrisjsewell added a commit that referenced this issue Mar 11, 2020
@chrisjsewell
Add conda install info and trim README
636fa88 
fixes #85
@chrisjsewell chrisjsewell linked a pull request Mar 11, 2020 that will close this issue
Add Footnote Syntax #117
Closed
@chrisjsewell
Copy link
Member

closed in #119

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
discussion no fixed close condition documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add Footnote Syntax executablebooks/MyST-Parser
2 participants
@choldgraf @chrisjsewell