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.

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

Merged
merged 1 commit into from
Oct 27, 2021
Merged

Conversation

nejraselimovic
Copy link
Contributor

@nejraselimovic nejraselimovic commented Oct 21, 2021

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

  • Scope: The referenced issue is addressed, there are no unrelated changes.
  • Run Locally: Verified that the docs build using make server, posted screenshots, verified external links.
  • New Features Marked: Documentation for new features is marked using the new-in-version shortcode, according to the guidelines in CONTRIBUTING.
  • Style Guidelines: Documentation obeys style guidelines in CONTRIBUTING.
  • Commits: Commit messages follow guidelines in CONTRIBUTING, there are no fixup commits left.

@CLAassistant
Copy link

CLAassistant commented Oct 21, 2021

CLA assistant check
All committers have signed the CLA.

@nejraselimovic nejraselimovic marked this pull request as ready for review October 22, 2021 13:14
@nejraselimovic
Copy link
Contributor Author

@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.

elsalahy
elsalahy previously approved these changes Oct 22, 2021
Copy link
Contributor

@elsalahy elsalahy left a 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?

@elsalahy
Copy link
Contributor

@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.

Good suggestion!
We link to applications in the home page twice, once in the headers and once under Documentation section.
I think we can also link Applications with Programming Software
I think we can also link Programming Software with Environment Setup as it's the natural step after it.

@nejraselimovic
Copy link
Contributor Author

Looks great @nejraselimovic rocket One question, is the changes to go.sum file needed?

Not that I know of, but I never edited that file so..

@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.

Good suggestion! We link to applications in the home page twice, once in the headers and once under Documentation section. I think we can also link Applications with Programming Software I think we can also link Programming Software with Environment Setup as it's the natural step after it.

Ah, didn't see that link for Applications. Good points you got there! I'll add those links in a fixup and merge

@elsalahy
Copy link
Contributor

Not that I know of, but I never edited that file so..

I think there is no issue with merging it, I was just curious

@nejraselimovic
Copy link
Contributor Author

@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?

@nejraselimovic nejraselimovic merged commit d4c1a4e into master Oct 27, 2021
@adriansmares adriansmares deleted the issue/fix-notes branch August 12, 2022 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Use note short-codes instead of markdown
3 participants