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.

Sign up for GitHub

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

Jump to bottom

Docs improvements #98

Merged
merged 23 commits into from
Jul 6, 2020
Merged

Docs improvements #98

merged 23 commits into from
Jul 6, 2020

Conversation

chrieke
Copy link
Contributor

@chrieke chrieke commented Jul 5, 2020 •
edited
Loading

Various docs improvements, main changes:

  • New frontpage inspired by BFE
  • Add automated CLI command reference (@rodrigoalmeida94 if possible we should probably adjust main to up42)
  • Add changelog to docs (similar to blockutils)
  • Add announcement bar on the top (Can be activated from time to time to highlight new features)

image
image

markusuwe
markusuwe approved these changes Jul 6, 2020
View reviewed changes
Copy link
Contributor

@markusuwe markusuwe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Super minor language improvements.

CHANGELOG.md Outdated Show resolved Hide resolved
docs/installation.md Outdated Show resolved Hide resolved
up42/catalog.py Outdated Show resolved Hide resolved
@rodrigoalmeida94 rodrigoalmeida94 mentioned this pull request Jul 6, 2020
Closed
rodrigoalmeida94
rodrigoalmeida94 approved these changes Jul 6, 2020
View reviewed changes
Copy link

@rodrigoalmeida94 rodrigoalmeida94 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fantastic! On the CLI added an issue in the package - mkdocs/mkdocs-click#6, let's see if we get a response. In any case, I think it's fair to merge as is.

README.md Show resolved Hide resolved
docs/examples-intro.md Show resolved Hide resolved
docs/support-faq.md Show resolved Hide resolved
@chrieke
Copy link
Contributor Author

chrieke commented Jul 6, 2020 •
edited
Loading

@rodrigoalmeida94 Thank you for creating the issue, would indeed be a good option for the plugin!

@chrieke chrieke merged commit 10cfb77 into master Jul 6, 2020
@chrieke chrieke deleted the docs-improvements branch July 6, 2020 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@markusuwe markusuwe markusuwe approved these changes

@rodrigoalmeida94 rodrigoalmeida94 rodrigoalmeida94 approved these changes

@marooned20 marooned20 Awaiting requested review from marooned20

@nekhtiari nekhtiari Awaiting requested review from nekhtiari

@thaisbendixen thaisbendixen Awaiting requested review from thaisbendixen

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chrieke @markusuwe @rodrigoalmeida94