More README.md fixes #1193
Merged
More README.md fixes #1193
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Scaladoc for "latest" is 2.11, so use a 2.11-style link - Use full path for SETUP.md - Switch migration guide to point to website version over wiki Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
edwardcwang
approved these changes
Sep 26, 2019
| @@ -107,7 +107,7 @@ These simulation-based verification tools are available for Chisel: | |||
| - [**Gitter**](https://gitter.im/freechipsproject/chisel3), where you can ask questions or discuss anything Chisel | |||
| - [**Website**](https://www.chisel-lang.org) | |||
|
|
|||
| If you are migrating from Chisel2, see [the migration guide on the wiki](https://github.com/ucb-bar/chisel3/wiki/Chisel3-vs-Chisel2). | |||
| If you are migrating from Chisel2, see [the migration guide](https://www.chisel-lang.org/chisel3/chisel3-vs-chisel2.html). | |||
There was a problem hiding this comment.
Giving up on the wiki...? :(
|
On 26 Sep 2019, at 19:55, edwardcwang ***@***.***> wrote:
@edwardcwang approved this pull request.
In README.md:
> @@ -107,7 +107,7 @@ These simulation-based verification tools are available for Chisel:
- [**Gitter**](https://gitter.im/freechipsproject/chisel3), where you can ask questions or discuss anything Chisel
- [**Website**](https://www.chisel-lang.org)
-If you are migrating from Chisel2, see [the migration guide on the wiki](https://github.com/ucb-bar/chisel3/wiki/Chisel3-vs-Chisel2).
+If you are migrating from Chisel2, see [the migration guide](https://www.chisel-lang.org/chisel3/chisel3-vs-chisel2.html).
Giving up on the wiki...? :(
Edward, I don't think we can have the same information at two places (if not automatically synced). I heard one saying "two copies are never the same".
You can edit the documentation hosted on GitHub almost like a Wiki. It just needs an approval and a merge, a little bit of overhead.
Cheers,
Martin
|
|
I am working on a solution to automatically sync the two sources of information. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Schuyler Eldridge schuyler.eldridge@ibm.com
Type of change: other enhancement
Impact: no functional change
Development Phase: implementation