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

improve github-pages #2

Closed
ynikitenko opened this issue Jul 3, 2022 · 2 comments
Closed

improve github-pages #2

ynikitenko opened this issue Jul 3, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@ynikitenko
Copy link
Owner

  • center the top button "View On GitHub" vertically,
  • create navigation between pages?
  • use hacker theme instead of midnight? Decide on its readability first. At the moment fonts are unreadable. Green sections look awesome, but maybe white is less distracting and better for reading a manual?
  • can't link to document sections (including manual and inter-manual links),
  • can't copy code with a click (as it is done on GitHub); not essential, but nice to have,
  • add an arrow "to the top of the page" at the bottom?
  • manual still looks a bit better in the terminal.
@ynikitenko ynikitenko added documentation Improvements or additions to documentation help wanted Extra attention is needed labels Jul 3, 2022
@ynikitenko
Copy link
Owner Author

Some time ago I decided to move to readthedocs completely, because of another (most important) issue: there is no easy way to automatically update github-pages for updated documentation, as is done on readthedocs (and they also store previous versions, which is great).

@ynikitenko
Copy link
Owner Author

I moved to readthedocs and Sphinx. There are still some documentation improvements left (like deletion of github-pages - should be done in the next release), but they are no longer related to this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant