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: Readme/Usage org idea #54

Merged
merged 7 commits into from
Jun 30, 2021

Conversation

stern-shawn
Copy link
Contributor

Docs

  • Making a pass at cleaning up the examples in the current README, bringing them together under the existing usage.md file, and organizing things
  • Fix broken syntax highlighting in usage.md
  • Clarifying provider arguments
  • General markdown linting

This is just an idea. I think usage.md is a pretty old file, and if it's not in use I can probably just port the new table of contents, etc back into the README if you feel that's more appropriate.

@childish-sambino childish-sambino changed the title Readme/Usage org idea docs: Readme/Usage org idea Jun 30, 2021
Copy link
Contributor

@childish-sambino childish-sambino left a comment

Choose a reason for hiding this comment

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

LGTM

@shwetha-manvinkurke shwetha-manvinkurke merged commit 806246c into twilio:main Jun 30, 2021
@stern-shawn stern-shawn deleted the docs-tidy-1 branch June 30, 2021 14:58
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.

None yet

3 participants