Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem: Too much friction to keep website up with current community activity #12

Open
weex opened this issue Aug 31, 2021 · 1 comment

Comments

@weex
Copy link
Member

weex commented Aug 31, 2021

To update the website under C4 requires a valid problem and pull request flow, but this is too high friction for many community updates. Static content in particular doesn't keep up to date with the latest discussions and changes.

Proposed solution: Include feeds from discussion forum, selected issue trackers, or the org itself.

@weex weex mentioned this issue Aug 31, 2021
@aschrijver
Copy link

Another solution that basically addresses this problem is Readme Driven Development (RDD).

It avoids copying/pasting texts, manual syncing, and following external links to catch up. An additional extension could be that the Markdown documents that are edited are part of a static site generator, so the website keeps in sync.

Imho neglecting updates like this is a kind of documentation tech debt that is never caught up to and solved properly. Developers hate documenting, especially after the fact and when they've forgotten most of the details and the effort is much greater.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants