Documentation updates#8
Merged
Merged
Conversation
azrosen92
changed the title
azrosen92
force-pushed
the
ar/readme-customizations
branch
from
February 19, 2025 22:23
3ad3696 to
3216716
Compare
azrosen92
commented
Feb 19, 2025
| <!-- End IDE Support [idesupport] --> | ||
|
|
||
| <!-- Start SDK Example Usage [usage] --> | ||
| <!-- No SDK Example Usage [usage] --> |
Collaborator
Author
There was a problem hiding this comment.
This is how we indicate to speakeasy not to overwrite a section in the README with generated docs.
Contributor
There was a problem hiding this comment.
I think we need to remove the <!-- Start [tag] --> altogether, right?
Collaborator
Author
There was a problem hiding this comment.
ahh yeah you're right, looks like I misread the instructions. Thanks!
azrosen92
commented
Feb 19, 2025
| with Gusto( | ||
| company_access_auth=os.getenv("GUSTO_COMPANY_ACCESS_AUTH", ""), | ||
| ) as gusto: | ||
| auth_token = os.getenv("GUSTO_COMPANY_ACCESS_AUTH", None) |
Collaborator
Author
There was a problem hiding this comment.
Some of @satanas's feedback – shorter lines, more validation, and use None over ""
azrosen92
marked this pull request as ready for review
February 19, 2025 22:45
satanas
reviewed
Feb 19, 2025
| <!-- End IDE Support [idesupport] --> | ||
|
|
||
| <!-- Start SDK Example Usage [usage] --> | ||
| <!-- No SDK Example Usage [usage] --> |
Contributor
There was a problem hiding this comment.
I think we need to remove the <!-- Start [tag] --> altogether, right?
|
|
||
| <!-- Start SDK Example Usage [usage] --> | ||
| <!-- No SDK Example Usage [usage] --> | ||
| ## SDK Example Usage |
Contributor
There was a problem hiding this comment.
nit: Since we're maintaining this section can we rename this title to just Example Usage? I'd like us to drop the usage of "SDK" whenever possible to avoid confusions.
| company. Then use the returned company access token for further requests. We'll do this in the following steps. | ||
| 1. [Create a Partner Managed Company](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#create_partner_managed) | ||
| 2. [View](https://flows.gusto.com/terms) and [Accept](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#accept_terms_of_service) Terms of Service] | ||
| 3. [Create a Company Location]() |
Collaborator
Author
There was a problem hiding this comment.
oops, good catch
| new partner managed company. In this section we will illustrate using a system access token to create a partner managed | ||
| company. Then use the returned company access token for further requests. We'll do this in the following steps. | ||
| 1. [Create a Partner Managed Company](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#create_partner_managed) | ||
| 2. [View](https://flows.gusto.com/terms) and [Accept](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#accept_terms_of_service) Terms of Service] |
Contributor
There was a problem hiding this comment.
Link for accept looks weird. Did you mean:
[Accept](https://github.com/Gusto/gusto-python-client/blob/main/gusto_embedded/docs/sdks/companies/README.md#accept_terms_of_service)] Terms of Service
| <!-- End SDK Example Usage [usage] --> | ||
|
|
||
| ### Common workflows | ||
| A common workflow, as documented [here](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company), is to create a |
Contributor
There was a problem hiding this comment.
super-nit: I'd give more context about where the link is pointing to. E.g:
as documented [in our docs](https://docs.gusto.com/embedded-payroll/docs/onboard-a-company)
azrosen92
force-pushed
the
ar/readme-customizations
branch
from
February 20, 2025 16:26
80825ae to
8a2bb4e
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Following Speakeasy's guide for customizing docs, updates the documentation to use more conventional python patterns, and adds some more useful code snippets. Adds a more practical usage example based on a real series of requests that a partner would make when following our company onboarding guide.