Update README.md with useful commands and tips #14
Conversation
- The first step to making these docs easy for others to develop - Update submodule pointer to more recent commit
There was a problem hiding this comment.
Looks really good, very nice way to help people through the configuration process. Feel free to add in my suggestions, but I think this would be good enough as is, not everyone needs to fully understand how to test but I think it's useful to have it documented.
README.md
Outdated
|
|
||
| To make the `docfx` command available after restoring the config file from the previous step, run: | ||
|
|
||
| `dotnet tool restore` |
There was a problem hiding this comment.
This is the only line I'm not sure is needed, doesn't the previous restore command pull everything in already?
There was a problem hiding this comment.
When I try to run dotnet docfx after running the previous restore command for the first time, it prints this:
I think you're right though. I don't think I should have to run dotnet tool restore again. dotnet might not be restoring correctly on my system when I run the first restore command. Something's amiss.
- Add instructions for doing the linkcheck commands before pushing - Add brief explainer on what the `dotnet docfx` command does - Add info on how to easily produce more bonsai screenshots
|
Jon made a comment to me: |
- Minor formatting etc.
|
@jonnew read this section of the readme about linkchecks. I can fix the broken references in the meanwhile though, if you'd like. Let me know |
|
Good edits. I added two comments that might clarify the initialization process which we were kinda confused about it earlier. |
- Also fix broken references
I request review from Brandon particularly in case I missed anything.
I request review from Jon because he has yet to build these docs. These instructions must be sufficient to enable him to do that or they need to be amended.