Project 14: The great divide
Schedule | Flex Meld |
Time allowed | 3 hours |
Update Realm
Update to the latest minor version of Realm.
At the time I write this, it's 0.91.5
.
Cheat: How to do this
Edit the package.json
and replace the version of Realm with 0.91.5
(or any other latest version).
package.json
"dependencies": { "@redocly/realm": "0.91.5" }
The great divide
A strategic shift is underway! The boss has decided to give the Museum API its own spotlight. They envision two distinct documentation experiences:
- Museum Showcase: A dedicated space for the Museum API.
- API Hub: A consolidated hub for the remaining APIs (Petstore and Train Travel, and any future additions).
Your task is to bring this vision to life using Redocly's multi-product capabilities.
Multi-product configuration
Cheat: Essential docs
Basic configuration:
- Organize your project files into the
museum
andapi-hub
folders according to their respective products. - Configure your
redocly.yaml
file to create two product sets: "Museum Showcase" and "API Hub".
- Organize your project files into the
Navbar Customization:
- Define separate navbar links for each product.
Logo Customization:
- Set a distinct logo for each product.
Additional Customizations (Optional):
- Implement any additional customizations to differentiate the two products.
Verification
- Multi-Product Picker: Verify the product picker appears in the navbar and allows seamless switching between "Museum Showcase" and "API Hub."
- Search Functionality: Test the search feature within each product to ensure it returns accurate results specific to the selected product's documentation.
Debrief
Debrief on your experience.
- What made you smile?
- What did you find confusing?