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 help files format and cohesion #19

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

RosieHendriksen
Copy link

Within this pull request I have edited the html and markdown helpfiles to make them consistent with each other, changed some formatting within the html file to make it easier to navigate and added links to additional tutorials and resources for TunnelX that exist on the internet.

The specific changes which have been made are:

to helpfile.html:
• Made the original html, html 5 Standards compliant
• Included a nav bar within the html page for easier navigation
• Added helpfileStyles.css for CSS styling for clearer formatting
• Moved the ‘Start Here’ section to the top of the page
• Made the contents of each section consistent with that of the more recently updated helpfile.md
• Added an ‘Additional Resources’ section with links to other tutorials/resources for Tunnel X online (the TunnelX wiki and a pdf walking through some of the tutorials)
• Updated the link to the projects GitHub page rather than Bitbucket

to helpfile.md:
• Moved the ‘Start Here’ section to the top of the page
• Fixed minor typos
• Added the same ‘Additional Resources’ section as that of helpfile.html

to readme.md
• Changed helpfile link in the readme file to direct to the helpfile.md rather than helpfile.html as the markdown version renders properly from within GitHub and is thus easier to read and clearer to use when viewing within GitHub.

The overall aims of these changes are to make the helpfiles more consistent with each other and clearer to use for the users.

@goatchurchprime
Copy link
Collaborator

goatchurchprime commented Mar 25, 2024

I found this PR purely by accident. I've now hopefully set up email notifications on this repo (if they work).

Has this "help" text been tested that it loads into tunnelx? (I'll try later if it hasn't been.)

@RosieHendriksen
Copy link
Author

Hiya, sorry for such a late reply. I haven't been able to test the full compiled version as I've been away and my current laptop is slightly allergic to Java. I would really appreciate it is you could give it a try and I would be happy to try to fix any problems that arise.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants