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

#249 Migrate static docs to new GH pages site #518

Merged
merged 4 commits into from
Jan 20, 2023

Conversation

TheCoolBlackCat
Copy link
Contributor

Description

  • Migrated the static documentation branch to a docs/ folder
  • Added CI to publish the static docs to GH pages

(#249) Starts the process of migrating to docs generated automatically, by creating a static site hosted on GH pages

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation update

Checklist:

  • I have read the CONTRIBUTING document.
  • My commits follow the commitizen commit convention
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@TheCoolBlackCat
Copy link
Contributor Author

@jwu910 I'm not sure if this will need an admin to turn on GH pages in the config, or if the CI tweak is enough but this should deploy the static docs. I'd like to add static generation from the README in CI at a later date if this PR LGTY?

@jwu910
Copy link
Owner

jwu910 commented Jan 15, 2023

Oh sweet! Thanks for opening this PR! I'll try to take a look when I get home!

Copy link
Owner

@jwu910 jwu910 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one minor request I can see from my phone, the CNAME might cause issues while I'm testing since I don't own checkit.club anymore.

I'll take another look when I get more time. Thanks again!

docs/CNAME Outdated Show resolved Hide resolved
Copy link
Owner

@jwu910 jwu910 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You know i have no clue how im going to go about testing this, i think i will just merge this in and figure it out.... Not touching any of the js code, should be fine. 🖖🏼

@jwu910 jwu910 merged commit 206243b into jwu910:main Jan 20, 2023
@jwu910
Copy link
Owner

jwu910 commented Jan 20, 2023

@all-contributors please add @TheCoolBlackCat for code, docs

@allcontributors
Copy link
Contributor

@jwu910

I've put up a pull request to add @TheCoolBlackCat! 🎉

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.

None yet

2 participants