Skip to content

add multiple api article and sidebar in open source repo#17

Merged
themattwilliams merged 8 commits intoRedocly:mainfrom
themattwilliams:add-new-article
Jun 27, 2025
Merged

add multiple api article and sidebar in open source repo#17
themattwilliams merged 8 commits intoRedocly:mainfrom
themattwilliams:add-new-article

Conversation

@themattwilliams
Copy link
Contributor

@themattwilliams themattwilliams commented Jun 9, 2025

Changes Made in Response to Feedback

  • Removed unnecessary bold tags from headings as they are automatically bolded in Redocly
  • Improved YAML formatting in examples for better readability

What/Why/How?

What: Added new documentation article about Arazzo and updated sidebars to include it in the navigation.

Why: Arazzo is a new OpenAPI specification for documenting workflows across multiple APIs. This documentation helps users understand how to use Arazzo to document complex API workflows, similar to how architects use circulation diagrams alongside room blueprints.

How:

  • Created new article documenting-multiple-apis-using-arazzo.md with comprehensive examples and explanations
  • Updated sidebars to include the new article in the navigation
  • Used architectural metaphors to explain complex concepts
  • Included real-world examples of Arazzo workflows

Reference

Testing

  • Verified all Mermaid diagrams render correctly
  • Checked all code examples for syntax accuracy
  • Validated all internal links and references
  • Tested the article in the local development environment

Screenshots (optional)

N/A - Documentation changes only

Check yourself

  • Code is linted
  • Tested
  • All new/updated code is covered with tests

Security

  • Security impact of change has been considered
  • Code follows company security practices and guidelines

Note: This is a documentation-only change that doesn't affect any security-sensitive code or functionality.

themattwilliams and others added 2 commits June 11, 2025 11:27
Co-authored-by: Adam Altman <adam@rebilly.com>
Co-authored-by: Adam Altman <adam@rebilly.com>
@themattwilliams
Copy link
Contributor Author

@adamaltman can you approve, or is there someone else I should ping?

@themattwilliams themattwilliams merged commit 95662eb into Redocly:main Jun 27, 2025
1 check passed
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.

2 participants