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

Create GitHub Action to automate building GitHub Pages documentation #9

Closed
wibbuffey opened this issue Oct 24, 2021 · 1 comment
Closed
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@wibbuffey
Copy link
Owner

Is your feature request related to a problem? Please describe.
We should have a GitHub Action created such that we do not need to manually update the website and wiki every time a change is made to the JSDoc source.

Describe the solution you'd like
Considering there are numerous different libraries created for the sole purpose of converting JSDoc to markdown and visa versa, we could use the following steps:

  • Rename all README.md files to index.md
  • Convert class/*.js into class/*.md (remove class/*.js afterwards)
  • Convert utils/*.js into utils/*.md (remove utils/*.js afterwards)
  • Move CODE_OF_CONDUCT.md, SECURITY.md, and CONTRIBUTING.md into .
  • Create Jekyll _config.yml
  • Commit/push to the pages branch
  • Rename class/*.md to class:-*.md and utils/*.md to utils:-*.md
  • Commit/push to wibbuffey/slope.wiki

Describe alternatives you've considered
Well, we could manually convert them like before, but that would be incredibly inefficient.

Additional context
N/A

@wibbuffey wibbuffey added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels Oct 24, 2021
@wibbuffey
Copy link
Owner Author

closed with the new site. things are a tad broken, but we'll get there

@wibbuffey wibbuffey added this to the v1.2.0 milestone Oct 29, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant