hotwired / strada-web Goto Github PK

Related to hotwired/turbo#997

The documentation pages for Stimulus are generated by commits in the project's docs/ directory. By automatically integrating the two repositories, contributors can propose documentation revisions simultaneously with source code revisions. Without tight integration, it's possible for changes to public interfaces (either through changes to internal JavaScript object properties and functions, Custom Element classes, or changes to CustomEvent.details) to drift from what's documented.

Since Strada targets three platforms (web, Android, and iOS), its circumstances are slightly different from Stimulus. Having said that, both the turbo-ios and turbo-android projects have their own self-contained docs/ directories that differ in content from the strada-site-generated pages (strada-ios handbook entry and strada-android handbook entry, respectively). In fact, the Handbook entries link directly to the GitHub repositories' docs/ directories.

The rest of the Strada Handbook and Reference sections generated from strada-site document Web-only concepts. That content would greatly benefit from staying synchronized with the source code.

What can be done to enable the same integration and lock step for the Strada project?