-
Notifications
You must be signed in to change notification settings - Fork 4
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
Use note shortcode, clean up docs #48
Conversation
@elsalahy I think there are still improvements to do, for example - application examples are there in a whole big section, but are not linked anywhere through the documentation. You could link them where you think it's relevant. Same thing with "programming software" section - if you don't link it anywhere, the user probably won't visit it (except if searching for it explicitly) because it's not a natural flow of reading docs. |
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.
Looks great @nejraselimovic 🚀
One question, is the changes to go.sum file needed?
Good suggestion! |
Not that I know of, but I never edited that file so..
Ah, didn't see that link for Applications. Good points you got there! I'll add those links in a fixup and merge |
I think there is no issue with merging it, I was just curious |
e403e45
to
d2b7418
Compare
@elsalahy no need to review again as I just added a few new links and rebased to squash commits, but the rebase dismissed your review, can you please approve again? |
Summary
Closes #47
Changes
Replaced note and other various occurrences of note with shortcode, improved readability by rephrasing some sentences, removing unnecessary indentations and similar, created a nicer docs flow (getting started -> choose SE or TE -> read welcome page -> read hw and sw setup page -> read hw and sw details).
Checklist
make server
, posted screenshots, verified external links.new-in-version
shortcode, according to the guidelines in CONTRIBUTING.