Skip to content

Refer to Unstructured docs in readme#109

Merged
awalker4 merged 2 commits intomainfrom
awalker4-patch-3
Jun 7, 2024
Merged

Refer to Unstructured docs in readme#109
awalker4 merged 2 commits intomainfrom
awalker4-patch-3

Conversation

@awalker4
Copy link
Copy Markdown
Collaborator

@awalker4 awalker4 commented Jun 7, 2024

Our docs page will be the source of truth, and the readme can have some general information from the autogenerated sections.

Changes:

  • Link to our docs at the top
  • Remove the manually created usage snippet and swap out for the autogenerated one. This way, the readme stays up to date while we focus on the docs page.
  • Bring back autogenerated error handling - this will populate the next time the client regens

Our docs page will be the source of truth, and the readme can have some general information from the autogenerated sections.

Changes:
* Link to our docs at the top
* Remove the manually created usage snippet and swap out for the autogenerated one. This way, the readme stays up to date while we focus on the docs page.
* Bring back autogenerated error handling - this will populate the next time the client regens
@awalker4 awalker4 requested a review from Coniferish June 7, 2024 15:42
@awalker4 awalker4 enabled auto-merge (squash) June 7, 2024 16:03
Copy link
Copy Markdown
Contributor

@Coniferish Coniferish left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@awalker4 awalker4 merged commit 9933e0e into main Jun 7, 2024
@awalker4 awalker4 deleted the awalker4-patch-3 branch June 7, 2024 22:51
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