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

Generated Rust docs include detritus from examples #765

Closed
daviddrysdale opened this issue Mar 25, 2020 · 1 comment
Closed

Generated Rust docs include detritus from examples #765

daviddrysdale opened this issue Mar 25, 2020 · 1 comment

Comments

@daviddrysdale
Copy link
Contributor

daviddrysdale commented Mar 25, 2020

Since #613 & #616, the generated docs for Rust crates at https://project-oak.github.io/oak include docs for every crate in the codebase, including pointless & empty pages for all of the examples.

The doc page would be much more helpful for Oak developers (both of and on Oak) if the example crates were dropped.

Ideally, it might also be nice to separate out:

  • docs for developers on Oak (oak_abi, oak, oak_tests)
  • docs for developers of Oak (oak_runtime, oak_glue)

(This is roughly the separation that older versions of the gh-pages branch had, between the sdk/ and server/ subdirectories, but it's not completely clear to be where the oak_abi crate should live with that division.)

@daviddrysdale
Copy link
Contributor Author

I think this is done already (by #1042, improved further by #1122).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants