The idea is to create some tooling that can detect what docs need to be written and updated in a way that it can be integrated with a CI pipeline, and integrate with task management systems and/or community management platforms. If the idea is possible, it'd be finally possible to visualize documentation debt and easily distribute documentation work. This could mean a lot less shouting at missing/out-of-date suffering for everybody.
Features are being planned out for really cool stuff regarding interoperability, in addition to IPFS/IPLD integration, which means it'd be really easy to experiment with different data formats, or different interfaces for navigating APIs and documentation which would normally require quite heavy refactoring.
If anyone is interested, please:
Open issues on the MaintainableDocs repo with design considerations, potential pitfalls, prior art, etc.
Ask me to write an article that I'd like to write but keep procrastinating on a really cool approach to interoperability with Storex.
I've just written down an idea that I'd like to start working on soon: https://github.com/ShishKabab/MaintainableDocs
The idea is to create some tooling that can detect what docs need to be written and updated in a way that it can be integrated with a CI pipeline, and integrate with task management systems and/or community management platforms. If the idea is possible, it'd be finally possible to visualize documentation debt and easily distribute documentation work. This could mean a lot less shouting at missing/out-of-date suffering for everybody.
I'd like to build this in TypeScript on top of Storex, a hyperflexible storage/data layer we're developing at WorldBrain for Memex: https://medium.com/worldbrain/storex-a-modular-and-portable-database-abstraction-ecosystem-for-javascript-c38194335c66 https://github.com/WorldBrain/storex
Features are being planned out for really cool stuff regarding interoperability, in addition to IPFS/IPLD integration, which means it'd be really easy to experiment with different data formats, or different interfaces for navigating APIs and documentation which would normally require quite heavy refactoring.
If anyone is interested, please: