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

Move documentation to separate website #77

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Move documentation to separate website #77

wants to merge 9 commits into from

Conversation

agriyakhetarpal
Copy link
Owner

Closes #5

@agriyakhetarpal agriyakhetarpal force-pushed the documentation branch 2 times, most recently from 65354ca to 9d2403b Compare April 6, 2024 19:23
@agriyakhetarpal
Copy link
Owner Author

Might work without the peaceiris action now that GitHub supports custom deployments

@agriyakhetarpal
Copy link
Owner Author

agriyakhetarpal commented Apr 8, 2024 •
edited
Loading

Working now, deployed at https://agriyakhetarpal.github.io/hugo-python-distributions/. Next steps are

  • Fill content for supported platforms
  • Configure weights for sidebars
  • Reorganise content as necessary
  • Add links and replace badges for the docs
  • Ensure nothing gets missed out

Though this isn't entirely ready yet, perhaps you could review, @arjxn-py?

@agriyakhetarpal agriyakhetarpal force-pushed the documentation branch 2 times, most recently from 09a4232 to 55dbee5 Compare April 14, 2024 21:20
@arjxn-py
Copy link

Though this isn't entirely ready yet, perhaps you could review, @arjxn-py?

I totally missed it 😬, Sorry.
Sure, I'd review this.

@agriyakhetarpal
Copy link
Owner Author

No worries

arjxn-py
arjxn-py reviewed Apr 22, 2024
View reviewed changes
Copy link

@arjxn-py arjxn-py left a comment

Choose a reason for hiding this comment

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

Thanks @agriyakhetarpal 🚀
This looks so good so far, I'd be happy to review it again in a while.

docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md Outdated Show resolved Hide resolved
docs/content/_index.md
{{</ callout >}}


{{< tabs items="Install it as an app globally, Run it" >}}
Copy link

Choose a reason for hiding this comment

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

Although it looks good but I personally think that tabs are good to divide platform dependent instructions but when it comes to this type of sections I prefer them to be straight & simple.
Tho it's just a thought not a suggestion as it looks nice as well.

Copy link
Owner Author

Choose a reason for hiding this comment

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

Good idea, I think too many tabs are confusing for the user. I have a lot to restructure on this page but I don't wish to rewrite the documentation again (or if I do, I wish to keep it minimal). I'll keep this conversation unresolved for now, thanks for the initial review! I plan to return to this soon enough

@agriyakhetarpal agriyakhetarpal added the documentation Improvements or additions tot the documentation for users and developers label May 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@arjxn-py arjxn-py arjxn-py left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions tot the documentation for users and developers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add documentation
2 participants
@agriyakhetarpal @arjxn-py