feat(website): add godoc-style documentation to gno packages #526
Conversation
|
Hey @yassinouider, thank you for this contribution. Yep, it’s related to #522 and going in the good direction. —- @thehowl, could you review this and consider integrating it with your work on #522 and suggest the next steps, please? |
moul
changed the title
Fixed the issue causing the golangci linter to fail by applying recommended changes to the code. Additionally, removed the feature for rendering package comments in the documentation template until a better solution is found.
|
thank you for your contribution :) 🎉 I'll take a look first thing on Monday |
Yes, it is a first effort but there is still a lot to do. |
…ning file map and update renderPackage method to reflect the change
yassinouider
requested review from
thehowl and
zivkovicmilos
and removed request for
thehowl and
zivkovicmilos
|
@moul @zivkovicmilos @thehowl when I think I have solved some reviews, should I close the conversation or you after checking ? |
|
We'll do. |
|
I didn't necessarily mean changing everything to Markdown, but this may be a good idea considering the spirit of the project and the idea of the defunct logos browser. In any case, I'll request a last round of reviews from Manfred and Miloš. As one last note, I also think it's probably better to add a few more test cases for code that is not covered yet, namely:
|
| @@ -193,6 +197,22 @@ func (vh vmHandler) queryFile(ctx sdk.Context, req abci.RequestQuery) (res abci. | |||
| return | |||
| } | |||
|
|
|||
| func (vh vmHandler) queryFiles(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) { | |||
There was a problem hiding this comment.
| func (vh vmHandler) queryFiles(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) { | |
| func (vh vmHandler) queryPkgFiles(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) { |
There was a problem hiding this comment.
After more reflection, I think we should not have a queryPkgFiles handler that gets the bodies, but instead implement the getPackage helper returning a list of files with attributes and not only the body: https://github.com/gnolang/gno/pull/526/files#diff-86850325e38fa997f532d762282030b3e585caa785324e2187eceba36e8169d5R121
There was a problem hiding this comment.
To avoid going in the wrong direction, you want me to return the std.MemPackage directly?
//keeper.go
func (vm *VMKeeper) QueryPackage(ctx sdk.Context, path string) (res std.MemPackage, err error) {
dirpath, _ := std.SplitFilepath(path)
store := vm.getGnoStore(ctx)
if memPkg := store.GetMemPackage(dirpath); memPkg != nil {
return memPkg, nil
}
return std.MemPackage{}, nil
}
//handler.go
func (vh vmHandler) queryPackage(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) {
dirpath := string(req.Data)
result, err := vh.vm.QueryPackage(ctx, dirpath)
if err != nil {
res = sdk.ABCIResponseQueryFromError(err)
return
}
b, err := json.Marshal(&result)
if err != nil {
res = sdk.ABCIResponseQueryFromError(err)
return
}
res.Data = b
return
}There was a problem hiding this comment.
It may be beneficial to keep the API as concise as possible, rather than having numerous options that essentially perform the same task.
| @@ -462,3 +462,13 @@ func (vm *VMKeeper) QueryFile(ctx sdk.Context, filepath string) (res string, err | |||
| return res, nil | |||
| } | |||
| } | |||
|
|
|||
| func (vm *VMKeeper) QueryFiles(ctx sdk.Context, path string) (res std.MemFileBodies, err error) { | |||
There was a problem hiding this comment.
| func (vm *VMKeeper) QueryFiles(ctx sdk.Context, path string) (res std.MemFileBodies, err error) { | |
| func (vm *VMKeeper) QueryPkgFiles(ctx sdk.Context, path string) (res std.MemFileBodies, err error) { |
| @@ -30,6 +32,14 @@ func (mempkg *MemPackage) GetFile(name string) *MemFile { | |||
| return nil | |||
| } | |||
|
|
|||
| func (mempkg *MemPackage) GetFileBodies() MemFileBodies { | |||
There was a problem hiding this comment.
| func (mempkg *MemPackage) GetFileBodies() MemFileBodies { | |
| func (mempkg *MemPackage) GetFileBodies() map[string]string { |
If you anticipate needing more helpers in the future, you can disregard this suggestion. However, if not, I believe this approach will be more discoverable and easier to upgrade later.
|
Please, look at this comment first, it's IMO the starting point -> #526 (comment) |
|
@yassinouider are you still interested in working on this? |
|
@thehowl |
Add new documentation to the package pages on gno.land, allowing developers to view information like pkg.go.dev.
Currently, the package pages on gno.land only display a list of files. I'm submitting this pull request to propose a new feature that will extract and generate documentation for Gno packages, similar to the way Godoc works for Go programs. For the moment it's a basic version, I just saw issue #522 which may bring a more complete version.
Gno.land.-.pkg.doc.mp4