top | item 26516546

(no title)

achou | 5 years ago

How do CodeTours handle drift as the code base changes?

discuss

rmorey|5 years ago

They have a GitHub Action to monitor this: https://github.com/marketplace/actions/codetour-watch

without CodeTour needing to do anything about it, you can just use git and name CodeTour based on git tag, hash or something.

Edit: It actually can reference a git ref, WOW: https://github.com/microsoft/codetour#versioning-tours

qbasic_forever|5 years ago

That doesn't really answer the question posed though--how does a tour stay up to date as code is changed? Does someone have to go in constantly and keep it up to date, pointing at the right spots, etc? It sounds like an incredible burden without dedicated staff or time to maintain--i.e. this is fine for projects established enough to have technical writers, evangelists, etc. but for 99% of projects it's just more burden and burnout. It's not really something you can farm out to your community or first time contributors either as deep analysis and understanding of a codebase takes real time and effort from the core devs.