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.

Sign up for GitHub

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

Jump to bottom

docs: update example READMEs to point to the docs #57

Merged
merged 3 commits into from
May 25, 2023
Merged

docs: update example READMEs to point to the docs #57

merged 3 commits into from
May 25, 2023

Conversation

raynerljm
Copy link
Contributor

@raynerljm raynerljm commented May 24, 2023 •
edited
Loading

Updated the example READMEs to point to the docs instead of listing the steps.

Additionally renamed a test constant from /callbackto /redirectas part of the effort to standardize the usage of our terms.

@raynerljm raynerljm requested a review from kwajiehao May 24, 2023 15:06
mantariksh
mantariksh reviewed May 25, 2023
View reviewed changes
Copy link
Contributor

@mantariksh mantariksh left a comment

Choose a reason for hiding this comment

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

wdyt about just pointing all the READMEs to the docs? same rationale as the main README, maintain a single source of truth

@raynerljm
Copy link
Contributor Author

pointed all the README to the docs following the Python Flask example. additionally added an installation step in the 'Local development' section.

@raynerljm raynerljm changed the title docs: update README to use redirect instead of callback docs: update example READMEs to point to the docs May 25, 2023
kwajiehao
kwajiehao approved these changes May 25, 2023
View reviewed changes
Copy link
Contributor

@kwajiehao kwajiehao left a comment

Choose a reason for hiding this comment

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

lgtm

@kwajiehao kwajiehao merged commit d4585cb into develop May 25, 2023
@kwajiehao kwajiehao deleted the docs/redirect branch May 25, 2023 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mantariksh mantariksh mantariksh left review comments

@kwajiehao kwajiehao kwajiehao approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@raynerljm @mantariksh @kwajiehao