Release Notes
Added
- Cross-section link annotation — all internal links now include
data-section-ref and data-section-path attributes on the rendered <a> element, enabling host applications to resolve entity page URLs at runtime. Works for both markdown links and diagram links (PlantUML $link URLs rendered via Kroki)
resolveSectionRefs option for mountRw() — host applications can provide a resolver that maps section refs to base URLs, enabling cross-entity link navigation in Backstage and other embedded contextssectionRef field on navigation items, scope info, and breadcrumbs in both server API and @rwdocs/core responses
Changed
- Section metadata field renamed from
type to kind to align with Backstage and Kubernetes conventions — type is still accepted in YAML for backward compatibility
- API responses now use a nested
section: { kind, name } object (was flat sectionType/sectionKind fields) and sectionRef string (e.g., domain:default/billing) on navigation items, scope info, and breadcrumbs
- Embedded viewer (
mountRw()) now uses flow layout — content takes its natural height and the parent page controls scrolling, instead of filling a fixed container with internal scroll. Hash fragment scrolling now works in embedded mode.
mountRw() API simplified — basePath and scopePath options replaced by a single sectionRef string; the viewer derives path mappings at runtime using resolveSectionRefs and the navigation API- Navigation API and
@rwdocs/core getNavigation() now accept sectionRef (e.g., "domain:default/billing") instead of a filesystem scope path — page responses return sectionRef instead of navigationScope
Removed
rw techdocs build and rw techdocs publish commands — use native Backstage plugins (rwdocs/backstage-plugins) insteadlinkPrefix option from @rwdocs/core createSite() config — use resolveSectionRefs in mountRw() for link URL construction in embedded mode
Install rw 0.1.18
Install prebuilt binaries via shell script
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/rwdocs/rw/releases/download/v0.1.18/rw-installer.sh | sh
Install prebuilt binaries via powershell script
powershell -ExecutionPolicy Bypass -c "irm https://github.com/rwdocs/rw/releases/download/v0.1.18/rw-installer.ps1 | iex"
Install prebuilt binaries via Homebrew
brew install rwdocs/tap/rw
Download rw 0.1.18
