search

tmcw / docbox

REST API documentation generator
ISC License
1.14k stars 190 forks source link

Proposal to remove generated code from being versioned #89

Closed eilgin closed 6 years ago

eilgin commented 6 years ago

This project is really cool as it allows us to quickly build an internal docs and communicate about the different way to use our APIs (cURL, JS, Java, etc).

The thing is that index.html and other generated code are versioned but locally modified by the build tools (to inject libs and other stuff).

Would it be better to exclude this file from being versioned and use a "sample" file instead especially since index.html hadn't change (and i bet won't) for a long time. It won't change the build steps from an user perspective as tools will take this into account.

eilgin commented 6 years ago

Sorry for the extra commits that got into this PR, i'll fix this (and the gitignore)

eilgin commented 6 years ago

@tmcw I've made the change you've asked, tell me that's ok for you!

tmcw commented 6 years ago

Thanks!