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

Extensive refresh of site for standardized structure #200

Merged
merged 2 commits into from
Dec 16, 2024

Conversation

MikeAdamsMews
Copy link
Contributor

Summary

Extensive refresh of site for a neater, better structured design that is standardized and unified with Connector API and POS API. A number of improvements to wording and presentation were made at the same time. Pathnames to API operations have not changed, but a number of other pathnames have changed. All internal links have been updated, and a .gitbook.yaml redirect file is included as a fallback to redirect any external deep links to old paths. [file to be added]

  1. Guidelines changed to Usage guidelines
  2. Simplified Usage guidelines home page to follow standard format, and moved content to sub-pages
  3. Added new page Authentication
  4. Added new page Environments (content moved here from mews-operations/README.md and channel-manager-operations/README.md)
  5. Renamed Whitelisting to Allowlisting and moved this content to the Environments page
  6. Added new page Compliance
  7. Added new section Use cases
  8. Added new use case page for Channels (content moved here from old Guidelines page)
  9. Added new use case page for Inventory updates (content moved here from old API Operations (CHM) page)
  10. API Operations (Mews) promoted to replace mews-operations/README.md and old file mews-operations/operations.md removed; all child pages also promoted
  11. API Operations (CHM) promoted to replace channel-manager-operations/README.md and old file channel-manager-operations/operations.md removed; all child pages also promoted
  12. Minor improvements to wording, style and presentation throughout.

Checklist

  • Documentation follows the Style Guide
  • JSON examples updated
  • Properties in JSON examples in same order as in property tables
  • Changelog dated the day when PR merged
  • Changelog accurately describes all changes
  • Changelog highlights the affected endpoints or operations
  • Changelog highlights any deprecations
  • All hyperlinks tested
  • Deprecation Table updated if any deprecations
  • SUMMARY.md updated if new pages added

@MikeAdamsMews MikeAdamsMews marked this pull request as ready for review December 13, 2024 16:02
@patrikmiksovsky95 patrikmiksovsky95 merged commit deaaacf into master Dec 16, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants