CalloutKeep the important context close to the step.
Rendered page
Links and navigation
Version context
Repository readyPreview
Keep your docs close to the code.
Docs for API teams, kept close to code and ready to review.
A working surface for the docs workflow.
✓Repository authoringwrite beside the code
✓Reusable patternsrepeat what works
✓API referenceendpoint content
✓Release noteskeep changes clear
✓Versionskeep context close
✓Searchfind the right page
✓Preview checksreview before publish
✓Migration supportmove in stages
Wallach workflowauthorversionreferencepreviewpublish
Make the patterns repeatable.
Give every page the same useful building blocks without making every page feel the same.
Use components for explanations, endpoint details, version notes, and the small moments that help readers keep moving.
Use original examples for cURL, JavaScript, and Python.
cURLJavaScriptPython
curl /v1/workspaces
--header authorization
response 200 OK
--header authorization
response 200 OK
Tabs: cURL / JavaScript / Python
workspace_id
Reference block: parameters, response, errors
changednew endpoint content
deprecatedprevious route
migratedversion note
Release block: changed, deprecated, migrated
Rendered page
Links and navigation
Version context
Ready for review
Preview
/v1/workspaces/{workspace_id}/pages
GET endpoint
Sample endpoint: GET /v1/workspaces/{workspace_id}/pages.
Check the rendered page, links, navigation, and version context before publishing.
A clear path from repository to preview.
Keep source, endpoint content, and preview together.
Turn the next docs change into a reviewable step.
WALLACH / WORKFLOW01 / AUTHOR
Write with code.
Keep guides and reference content in a repository-shaped workspace.
/docs/getting-started.mdx
02 / GENERATE
Shape the reference.
Use endpoint content, examples, and reusable blocks together.
GET /v1/workspaces/:id/pages
03 / REVIEW
Preview before publishing.
Check links, navigation, and version context in one rendered pass.
preview: ready for review
Find the right version
- Version switcher: Current / v2 / v1
- Search prompt: Search guides and reference
Wallach
v2.4 current
v2.3 previous
v1 archive
Release notes
Search guides, endpoints, and release notes
RESULT / API REFERENCE
Workspace pages
Open the current endpoint reference without losing the version context around it.
/v2.4/reference/workspaces/pages
Keep current and previous docs visible without making the reader guess where a page went.
Useful patterns, shown in context.
Use the same patterns across guides, reference, and releases.
CalloutKeep context beside the action.
Component catalog
Original patterns for guides and reference.
Code tabs
cURL, JavaScript, and Python.
GET /pagesparameters
response
errors
response
errors
Reference blocks
Parameters, response, and errors.
changednew content
deprecatedold route
migratednew version
Release blocks
Changed, deprecated, migrated.
GET
/v1/workspaces/{workspace_id}/pages
200 OK
/v1/workspaces/{workspace_id}/pages
200 OK
GET endpoint
Reference beside the explanation.
curl https://api.wallach.example/v1/workspaces/ws_123/pages
-H Authorization: Bearer
$WALLACH_TOKEN
-H Authorization: Bearer
$WALLACH_TOKEN
Request examples
Original examples for the docs team.
Review the rendered page.
Preview checks keep the useful details visible before a change is published.
Rendered page
Read the page as a developer will see it.
Links and navigation
Check the route, hierarchy, and page connections.
Version context
Keep the selected version visible through the review.
API examples
Compare the endpoint explanation with its request.
Release notes
Make changed and migrated content easy to scan.
Ready for review
Leave a clear next step for the docs team.
Move docs in clear steps
Map the current structure, then review the first pages before moving more.
Guidesinventory
API referenceinventory
Release notesreview
Navigationready
Content inventory
Start with the pages and routes already in motion.
/guides
→ /v2/guides
/reference
→ /v2/reference
→ /v2/guides
/reference
→ /v2/reference
Map routes and versions
Keep the destination structure visible before moving pages.
Calloutsconverted
Code tabsconverted
API blocksreview
Convert components
Move reusable pieces in deliberate stages.