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

Update v5 docs #384

Merged
merged 29 commits into from May 3, 2024
Merged

Update v5 docs #384

merged 29 commits into from May 3, 2024

Conversation

colincasey
Copy link
Contributor

@colincasey colincasey commented Mar 17, 2024

This PR will be the staging area for multiple stacked PRs that update our API docs with markdown pages generated from TypeScript signatures + @tsdoc annotations. I'm introducing the API Extractor into our develop toolchain to handle this.

The main landing page which is linked to from the README is here:
https://github.com/salesforce/tough-cookie/blob/v5-docs/api/docs/tough-cookie.md

And the README changes:
https://github.com/salesforce/tough-cookie/blob/v5-docs/README.md

The idea is to:

  • keep API docs are accurate since they will be generated automatically to match code
  • allow for our README.md to be simpler since API docs can be moved to a dedicated area
  • provide some guardrails against breaking API changes using the API Extractor tooling since the API Report output can be used as a basis for API review workflow

Note

This PR will be marked as a draft until all the following child PRs in this stack have been reviewed and merged

@colincasey colincasey merged commit 4e04082 into master May 3, 2024
8 checks passed
@colincasey colincasey deleted the v5-docs branch May 3, 2024 19:48
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

2 participants