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

Publish godoc of this repo #1059

Closed
moul opened this issue Aug 18, 2023 · 3 comments
Closed

Publish godoc of this repo #1059

moul opened this issue Aug 18, 2023 · 3 comments
Assignees
Labels
🗺️good first issue🗺️ Ideal for newcomer contributors

Comments

@moul
Copy link
Member

moul commented Aug 18, 2023

Problem: Currently, we're facing an issue with pkg.go.dev not recognizing our custom LICENSE, which is preventing the display of our project's generated documentation.

Solution: To work around this, we've decided to use the official godoc -http tool. We've laid the initial groundwork for this approach in this pull request: #884.

Next Steps:

  1. Verify Generated Documentation: Since we're relying on a locally exposed HTTP server, there's a chance of broken links or inaccurate content in the generated documentation. Ensuring that the documentation is correct is essential.

  2. Complete Configuration: We're in the process of finalizing the configuration to enable the display of the generated documentation, potentially through GitHub Pages.

  3. Setting Up a Custom Domain: To make the documentation more accessible, we're considering setting up a custom domain name, which would make it easier to locate.

Related with #1046 (may want to use the same docs.gno.land URL?).

@moul moul added 🗺️good first issue🗺️ Ideal for newcomer contributors help wanted labels Aug 18, 2023
@waymobetta
Copy link
Contributor

Perhaps we could host this on a different subdomain; ie, pkg.gno.land in keeping with the Go documentation server theme (unless we plan on altering this theme) and then have higher-level documentation live on docs.gno.land. If this introduces confusion, we can easily just consolidate into docs.gno.land down the road.

@waymobetta
Copy link
Contributor

We can also utilize an alternative to godoc, a tool called golds if we wished to customize formatting a bit further, otherwise we can stick to godoc if we wish the theme to be more in-keeping with Go.

golds example

Along with different coloration and formatting, golds also provides analytics.

golds example: statistics

Screenshot 2023-08-21 at 1 51 00 PM

@moul moul added this to the 💡Someday/Maybe milestone Sep 6, 2023
@thehowl
Copy link
Member

thehowl commented Dec 21, 2023

This has been added since #1251

I think it makes sense for the documentation of the gno repository to live on github.io. Maybe we should consider moving it if we want to move to being GitHub-agnostic in our import paths using vanity imports. (maybe something like src.gno.land for hosting the gno repo, or src.gno.land/gno); in which case that could take the godoc documentation.

In any case, the tool's been developed and works decently (IMO). We can iterate on that.

@thehowl thehowl closed this as completed Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🗺️good first issue🗺️ Ideal for newcomer contributors
Projects
Status: 🔵 Not Needed for Launch
Development

No branches or pull requests

3 participants