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 the documentation html files to look nicer in a browser #1

Open
JockeJarre opened this issue Oct 29, 2023 · 3 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@JockeJarre
Copy link
Collaborator

Currently the html files are linked from the main repository page. The same files are used for the HTMLHELP file, which is fine, but there would be nice to have a TOC in the browser as well.

@JockeJarre JockeJarre added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Oct 29, 2023
@Pooja1672
Copy link

Hi @JockeJarre , Can you assign this issue to me?

@JockeJarre
Copy link
Collaborator Author

Hi @JockeJarre , Can you assign this issue to me?

No need, you are welcome to help out!

Short introduction:

  • Press "fork" up in the header (you get your own copy of the repo).
  • you can work at your own pace there.
  • When you are finished, you can create a pull request for me to check.

Once again welcome!

/Jarr3

@JockeJarre
Copy link
Collaborator Author

Do not forget, that it would be nice if it still works with generating the documentation htmlhelp file afterwards too.

So maybe easiest to add some html stuff around it which adds the files in a TOC and shows the documentation next to it?

If you try something out we can put it in a separate branch and each push will generate a new build. Should also do that in your local copy...

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 good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants