-
Notifications
You must be signed in to change notification settings - Fork 79
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
Consolidate documentation #301
base: master
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a large work, thank you. At some point please squash the commits into one.
@@ -0,0 +1,74 @@ | |||
<div align="center"> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you add html elements to markdown? Is it a standard?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, sort of. GitHub does (see their GitHub Flavored Markdown spec) and so do pretty much all Markdown flavors that are based on the CommonMark spec (which is most of them).
The usage of HTML here is just for eye candy though, so we could run with plain Markdown just as well
## Features | ||
|
||
- Supports a variety of [target architectures](#supported-platforms) | ||
- Supports a large number of operations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like the repeat of readme. When somebody modify one of them, it is easy to forget about the other. Would be good to figure out something for this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if there is a nice solution for this. I could remove the info from the introduction, but I would definitely keep it in the README as it is the primary entry point for people looking at this project.
The second part of my series of documentation improvements discussed here: #292 / #285.
This PR addresses the following: