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

docs: Remove table of contents from README #2697

Merged
merged 6 commits into from
Oct 24, 2023
Merged

Conversation

kdestin
Copy link
Member

@kdestin kdestin commented Oct 1, 2023

Description

This pull request updates the root README, and replaces the table of contents with a textual description of the repository.

Checklist

  • I have read the contribution guidelines
  • I have coordinated with the docs team ([email protected]) if this PR deletes files or changes any file names or file extensions.
  • Pull request includes test coverage for the included changes.
  • This notebook or file is added to the CODEOWNERS file, pointing to the author or the author's team.

README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
    It doesn't really make a ton of sense to expose the root
    README as a sample.
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Show resolved Hide resolved
@kdestin kdestin enabled auto-merge (squash) October 24, 2023 19:44
@kdestin kdestin disabled auto-merge October 24, 2023 22:39
@kdestin kdestin merged commit f643939 into main Oct 24, 2023
4 checks passed
@kdestin kdestin deleted the kdestin/update-readme branch October 24, 2023 22:39
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.

2 participants