Documentation link points directly to API reference (GraphemeCache) #305
-
|
Hello, I noticed that the website link in the repo description leads directly to the generated API documentation (specifically landing on internal structs like GraphemeCache or the root namespace). 
Because it uses the standard Zig docs styling, at first glance it looks like a link to the Zig language documentation rather than the libvaxis docs. Is this intended to be the main landing page, or is there a plan to point it to a more general guide/README in the future? It might be a bit confusing (Or it is just for me, sorry for disturbing). 
|
Beta Was this translation helpful? Give feedback.
Replies: 1 comment
-
|
Pointing to the wrong part of the API is a small bug in the As for pointing to a more general README, I think the intent of those docs is specifically as an API reference. A separate guide might be a good idea though! |
Beta Was this translation helpful? Give feedback.
Pointing to the wrong part of the API is a small bug in the
build.zigdue to a little bit of awkwardness with how Zig creates its autodocs. If there's not already a PR for it, it shouldn't be too hard to get that fixed.As for pointing to a more general README, I think the intent of those docs is specifically as an API reference. A separate guide might be a good idea though!