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

add missing links to Summary and Data Systems #118

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

agilgur5
Copy link

@agilgur5 agilgur5 commented Jul 5, 2023

Summary

Noticed there were some missing links in a few places

Details

  • Summary was missing two links:
    • "Lazy vs Eager Execution", which had a few links to it - those links ended up directing to the source code of the GitBook directly instead of the rendered docs (see screenshot)
    • "Conquering the Python Environment", which seemed to have no links to it
      • discovered it while editing the docs myself and noticing that it was missing from the Summary
  • Data Systems was missing an S3 link

Screenshot

Of a link going to source instead of rendered docs -- see bottom left linking to GitHub directly:
Screen Shot 2023-07-04 at 8 39 07 PM

Future Work(?)

  • The top-level README is also missing some links, but not sure if that is intentional or not. As in, if it only has a selection of links intentionally.

    • Installation docs, Notifications docs, Parameters docs, LLM SDK reference, etc are not linked to from the README
  • Some examples from the main source repo seem to be missing as well. Similarly not sure if that is intentional or not

    • Resnet, March Madness, etc are not in the example workflows
    • The release script does not include those examples

- Summary was missing two links:
  - "Lazy vs Eager Execution", which had a few links to it
    - those links ended up directing to the source code of the GitBook directly instead of the rendered docs (see screenshot)
  - "Conquering the Python Environment", which seemed to have no links to it
    - discovered it while editing the docs myself and noticing that it was missing from the Summary
- Data Systems was missing an S3 link
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant