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

Create HTML version of Help to make available through website #186

Open
Tracked by #1031
ACowan0105 opened this issue Jul 19, 2022 · 7 comments · Fixed by #1239
Open
Tracked by #1031

Create HTML version of Help to make available through website #186

ACowan0105 opened this issue Jul 19, 2022 · 7 comments · Fixed by #1239
Assignees
@moraru @CodeByDrescher
Labels
To Refine issue is either too large in scope or undefined User Materials

Comments

@ACowan0105
Copy link
Contributor

Help originally create by Li Ye, can find by checking repository for Li Ye
@CodeByDrescher CodeByDrescher added this to the Documentation of VCell milestone Dec 20, 2022
@jcschaff
Copy link
Member

jcschaff commented Nov 3, 2023

The technology for web based help has evolved over time, need to see what is our best option. Nice thing is that our help system is encoded in a structured/semantic way. Don't recall what Li Ye did years ago, but probably a good time to consider newer solutions.

@jcschaff jcschaff added To Refine issue is either too large in scope or undefined zenhub labels Nov 3, 2023
@ACowan0105
Copy link
Contributor Author

@jcschaff we have discussed this several times over the years. At one point Dan found a newer version of the java help we had used, but it never progressed beyond that.

@jcschaff jcschaff mentioned this issue Nov 13, 2023
Open
9 tasks
@jcschaff jcschaff removed this from the Documentation of VCell milestone Nov 15, 2023
@ACowan0105
Copy link
Contributor Author

Create a way to use the current documentation structure to automatically output an HTML file of the current Help version and deposit within the web site.

@jcschaff jcschaff linked a pull request May 5, 2024 that will close this issue
update vcell help #1239
Merged
@jcschaff
Copy link
Member

jcschaff commented May 5, 2024

see #1225

  • update 7.5 alpha help prior to release)

see #1239

  • refactored help generator to pave way for separating web and desktop help
  • improved index.html on web using nested lists
  • improved image layout (still not quite right)
  • Github Actions now automatically deploy each time software is deployed
  • see up-to-date but poorly formated web help vcell.org web help

@jcschaff
Copy link
Member

jcschaff commented May 5, 2024

@AlexPatrie can you suggest small changes to HTML markup or CSS to improve our online help. Also - could generate markdown or other content which may be more search or LLM friendly.

@AlexPatrie
Copy link

@AlexPatrie can you suggest small changes to HTML markup or CSS to improve our online help. Also - could generate markdown or other content which may be more search or LLM friendly.

@jcschaff Yes! I would be happy to take a look. I will start with this link.

@vcellmike
Copy link
Contributor

vcellmike commented May 28, 2024 •
edited by CodeByDrescher

New pages are not displayed online, while are shown in TOC.
See (empty checkbox means still broken):

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@moraru moraru

@CodeByDrescher CodeByDrescher

Labels
To Refine issue is either too large in scope or undefined User Materials
Projects
vcell development
Status: Active
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

update vcell help virtualcell/vcell
6 participants
@moraru @jcschaff @vcellmike @ACowan0105 @AlexPatrie @CodeByDrescher