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

autodoc follow-up enhancements and bug fixes #19249

Open
1 of 25 tasks
andrewrk opened this issue Mar 11, 2024 · 10 comments
Open
1 of 25 tasks

autodoc follow-up enhancements and bug fixes #19249

andrewrk opened this issue Mar 11, 2024 · 10 comments
Labels
autodoc The web application for interactive documentation and generation of its assets. bug Observed behavior contradicts documented or intended behavior enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Milestone

Comments

@andrewrk
Copy link
Member

andrewrk commented Mar 11, 2024

Extracted from #19208.

  • make the panic handler reflect the failure in the user interface
  • when navigating back to search results, up+down arrow should keep working
  • redundant search results (search "format")
  • in query_exec_fallible, sorting should also check the local namespace inside the file
  • walk assign_destructure not implemented yet
  • escape URLs when rendering html (look for missing_feature_url_escape)
  • implement renderHome for multiple modules
  • struct fields: render each component separate rather than via source rendering
  • infer comptime_int constants (example: members of #std.time)
  • when global const has a type of type, categorize it as a type despite its value
  • show abbreviated doc comments in types and namespaces listings
  • show type function names as e.g. ArrayList(T)
  • enum fields should not be linkified (example: std.log.Level)
  • shrink Ast to fit the slices
  • linkification of methods (example: std.array_hash_map.ArrayHashMap.count)
  • navigating to source from a decl should scroll to the decl
  • in source view, make @imports into links, but keep same syntax highlighting
  • include struct field names and doc comments in search query matching
  • include function parameter names and doc comments in search query matching
  • instead of logging "can't index foo because it has syntax errors" put it in the UI
  • in Walk.expr() it is missing support for asm_input/asm_output nodes
  • in renderNamespace, handle an aliasing loop
  • add a history item when clicking a search result (it already works when keyboard triggered)
  • instead of "declaration not found", show the decl that can't be penetrated (example: #std.os.system.fd_t)
  • better handle indentation when rendering source code #19293
@andrewrk andrewrk added bug Observed behavior contradicts documented or intended behavior enhancement Solving this issue will likely involve adding new logic or components to the codebase. autodoc The web application for interactive documentation and generation of its assets. labels Mar 11, 2024
@andrewrk andrewrk added this to the 0.13.0 milestone Mar 11, 2024
@vesim987
Copy link
Contributor

vesim987 commented Mar 11, 2024

  • anytype parameters are missing in function view

@xdBronch
Copy link
Contributor

functions with parameters on multiple lines are rendered weirdly
image
should either trim the whitespace or render on multiple lines here as well

@wooster0
Copy link
Contributor

when navigating through search results beyond the page with arrows keys the page should be scrolled down or up before the selected result goes out of view

@sno2

This comment has been minimized.

@xdBronch

This comment was marked as resolved.

@sno2

This comment was marked as resolved.

@alwinb
Copy link

alwinb commented Mar 27, 2024

With all this activity, maybe it is a good time for me to overcome my shyness and point to an alternative layout for the UI that I did some year ago whilst learning zig.

https://github.com/alwinb/zig-autodoc-ui

Live version here:

https://alwinb.github.io/zig-autodoc-ui/

I'm sure it would be easy to adapt the css for the new version.

Otherwise maybe it can serve as a bit of inspiration.

@AndrewKraevskii
Copy link
Contributor

Public fields and functions inside of struct inside of test shown in docs but they shouldn't.
https://ziglang.org/documentation/master/std/#std.meta
image

@sorairolake
Copy link

I think it would be useful to be able to also generate documentation which doesn't include binary files (main.wasm and sources.tar) if possible. This should help reduce the repository size when managing the documentation using Git. Otherwise, I think the current situation is better because the generated document size is smaller.

@nektro
Copy link
Contributor

nektro commented May 8, 2024

additionally wrt sources.tar it would be nice if packages could define an external url where the source is located and the site would link to that instead of using the builtin source view.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
autodoc The web application for interactive documentation and generation of its assets. bug Observed behavior contradicts documented or intended behavior enhancement Solving this issue will likely involve adding new logic or components to the codebase.
Projects
None yet
Development

No branches or pull requests

9 participants