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

feat(docs): script to gen godoc and publish on gh-pages #884

Merged
merged 3 commits into from
Jun 14, 2023

Conversation

moul
Copy link
Member

@moul moul commented Jun 10, 2023

  • script to fill the docs/ folder with things that can be generated from source (godoc, what else?)
  • github actions calling that script, then publishing the content on the gh-pages branch when a PR is merged on master

Once merged, we'll see the result and will be able to make it better, i.e., adding index, custom theme, fix broken links.

Btw, we need this because the current LICENSE file is not supported by pkg.go.dev.

CleanShot 2023-06-10 at 10 56 25@2x

Contributors Checklist

  • Added new tests, or not needed, or not feasible
  • Provided an example (e.g. screenshot) to aid review or the PR is self-explanatory
  • Updated the official documentation or not needed
  • No breaking changes were made, or a BREAKING CHANGE: xxx message was included in the description
  • Added references to related issues and PRs
  • Provided any useful hints for running manual tests

Maintainers Checklist

  • Checked that the author followed the guidelines in CONTRIBUTING.md
  • Checked the conventional-commit (especially PR title and verb, presence of BREAKING CHANGE: in the body)
  • Ensured that this PR is not a significant change or confirmed that the review/consideration process was appropriate for the change

moul added 2 commits June 9, 2023 11:13
Signed-off-by: Manfred Touron <94029+moul@users.noreply.github.com>
Signed-off-by: Manfred Touron <94029+moul@users.noreply.github.com>
@moul moul self-assigned this Jun 10, 2023
@moul moul changed the title dev/moul/gendocs feat(docs): script to gen godoc and publish on gh-pages Jun 10, 2023
Signed-off-by: Manfred Touron <94029+moul@users.noreply.github.com>
@moul moul marked this pull request as ready for review June 10, 2023 08:55
@moul moul requested a review from a team as a code owner June 10, 2023 08:55
Copy link
Contributor

@ajnavarro ajnavarro left a comment

Choose a reason for hiding this comment

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

LGTM

@moul moul merged commit 99633b9 into gnolang:master Jun 14, 2023
9 checks passed
@moul moul deleted the dev/moul/gendocs branch June 14, 2023 16:47
@moul moul mentioned this pull request Aug 18, 2023
Doozers pushed a commit to Doozers/gno that referenced this pull request Aug 31, 2023
@moul moul added this to the 🌟 main.gno.land (wanted) milestone Sep 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants