Skip to content

SELFDEV-576 + DEVDOCS-5863: [organize] Make docs structure match IA, move newer public docs to public repo#324

Merged
slsriehl merged 11 commits intomainfrom
match-ia
Jun 12, 2024
Merged

SELFDEV-576 + DEVDOCS-5863: [organize] Make docs structure match IA, move newer public docs to public repo#324
slsriehl merged 11 commits intomainfrom
match-ia

Conversation

@slsriehl
Copy link
Contributor

@slsriehl slsriehl commented Jun 10, 2024

SELFDEV-576 + DEVDOCS-5863

What changed?

  • Make docs structure match IA
  • BOPIS and promotions docs into public repo
  • Other than adding the spec files from bopis and promotions to the dev center, i did not reorganize the API reference because that requires comms and advance notice to everyone who maintains an API client or SDK.

Release notes draft

  • The bigcommerce/docs repo now contains the OAS for promotions, inventory, locations, and other newer API features!
  • It's now easier than ever to contribute to the docs. The source file structure in the repo now matches the Dev Center URLs. Finding the doc you want to modify never had less friction :)
  • This only applies to the narrative docs. API reference source file restructure is in the works as soon as we can give enough notice for all you API client maintainers to reset your references.

Anything else?

ping @bc-tgomez @bc-traciporter

@slsriehl slsriehl requested a review from bc-tgomez June 10, 2024 21:08
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

sarif

reference/promotions.v3.yml|1506 col 20| type: object must have a properties sibling.
reference/promotions.v3.yml|1644 col 14| Schemas with "type: array", require a sibling "items" field
reference/promotions.v3.yml|1644 col 14| type: array must have an items sibling.

@slsriehl
Copy link
Contributor Author

I made some of the retext changes, particularly typos. Changing more is beyond the scope of this work, and retext will fail given the number of files in the PR, for rate limiting reasons.

@slsriehl slsriehl merged commit 66dbab0 into main Jun 12, 2024
@slsriehl slsriehl deleted the match-ia branch June 12, 2024 21:15
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.

1 participant