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

Convert documentation to GitHub pages #8

Open
dieggsy opened this issue Mar 7, 2025 · 5 comments
Open

Convert documentation to GitHub pages #8

dieggsy opened this issue Mar 7, 2025 · 5 comments
Labels
help wanted Extra attention is needed

Comments

@dieggsy
Copy link
Collaborator

dieggsy commented Mar 7, 2025

I'm don't think pointing users to a website we have no control over or a PDF/HTML file in the repo is a great practice.

GitHub wiki seems like a possible alternative.

@dieggsy
Copy link
Collaborator Author

dieggsy commented Mar 7, 2025

@sionescu could we add a wiki to this repository? I don't think I can do it myself

@PuercoPop
Copy link
Contributor

@dieggsy if one can generate the docs from the files in repo publishing them under GitHub pages seems like the path of least resistance

@sionescu
Copy link
Member

sionescu commented Mar 7, 2025

I would suggest using a static site generator that pushes to Github Pages, like this: https://github.com/sionescu/bordeaux-threads/blob/master/.github/workflows/gh-pages-deployment.yml

@dieggsy
Copy link
Collaborator Author

dieggsy commented Mar 7, 2025

GitHub pages sounds like a good idea. Where would they be hosted though? Would we need a sharplispers.github.io?

@dieggsy dieggsy changed the title Convert documentation to GitHub wiki Convert documentation to GitHub pagse Mar 7, 2025
@dieggsy dieggsy changed the title Convert documentation to GitHub pagse Convert documentation to GitHub pages Mar 7, 2025
@sionescu
Copy link
Member

sionescu commented Mar 7, 2025

GH pages will be hosted by default under sharplispers.github.io/clsql.

@dieggsy dieggsy added the help wanted Extra attention is needed label Mar 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants