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

Documentation: adoption of docsify for documentation pages #103

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

Conversation

allysonsouza
Copy link
Contributor

Since our just-the-hm-docs is not being updated in a while and it's not compiling with the latest Ruby/Jekyll, I thought about this as an opportunity to adopt a third-party, easy to setup and updated solution, it's when I've found docsify, which seems to work really nice.

This way we could get rid of wiki, concentrating documentation on the same repository as code.

@roborourke
Copy link
Contributor

Not come across this before. Do we publish docsify via GitHub pages? Is there an action or something we can use for that?

Also rather than duplicating the README.md, GitHub will look in docs/ for a readme if there isn't one in the root directory.

@allysonsouza
Copy link
Contributor Author

I guess it's statically built locally and served trough /docs dir, so we should just point the repository settings to a branch and this directory.

@allysonsouza allysonsouza marked this pull request as ready for review January 27, 2025 13:00
@roborourke
Copy link
Contributor

Which repository settings are you referring to?

@allysonsouza
Copy link
Contributor Author

@goldenapples
Copy link

We discussed updating or replacing this pull request to use just-the-hm-docs instead of docsify for consistency with other projects. However, the documentation updates in this branch (to the "Testing SSO Locally" page) should be preserved.

@roborourke
Copy link
Contributor

@goldenapples if it's unlikely just-the-hm-docs will be updated any time soon I think for the sake of pragmatism just having readmes available is fine.

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

Successfully merging this pull request may close these issues.

3 participants