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

Add Github pages for reading the spec #18

Open
christianparpart opened this issue Jun 12, 2021 · 2 comments
Open

Add Github pages for reading the spec #18

christianparpart opened this issue Jun 12, 2021 · 2 comments
Labels
help wanted Extra attention is needed

Comments

@christianparpart
Copy link
Member

the github page should:

  • allow reading the spec online right from that page (maybe the markdown version and optionally a link to the PDF)?
  • have a link to the actual github repo
  • this should somehow be auto-generated via CI (Github Actions), just like currently done with the (pre-)releases
@christianparpart christianparpart added the help wanted Extra attention is needed label Jun 12, 2021
@wez
Copy link

wez commented Jun 15, 2021

I don't have bandwidth for this directly, but you could potentially leverage https://github.com/wez/wezterm/blob/main/.github/workflows/pages.yml which is the action I use to publish the wezterm docs to gh_pages using mdbook. I don't think you need mdbook for this; the key thing is the publish stage at the bottom: https://github.com/wez/wezterm/blob/main/.github/workflows/pages.yml#L44

@christianparpart
Copy link
Member Author

Thanks for that! :)

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

2 participants