#engine devex: regenerating docs on rebase?
1 messages ยท Page 1 of 1 (latest)
this got buried and nobody saw it... maybe @pure wasp or @trail mortar have thoughts?
engine devex: regenerating docs on rebase?
I have no idea what that's about. I've never had to resolve any conflicts in that file, but just off the file path it's surely the PHP reference docs. Do we commit the result of the build? Why not build on CI before publishing? That's what happens with the other SDKs. Not the CLI reference though, but that produces markdown. Is there a particular part of that file that you hit more conflicts? Like a random hash for a class name or something that's different every time.
ah @narrow socket, we've talked about this before - we should just be able to cleanup the JSON after generation
currently our docs do not have a dagger build step
they should ๐
but given the way we deploy through netlify, i'm not sure how feasible it is without changing some of the flow ๐ค
clean up meaning format or remove and regenerate?
I think we've discussed cleaning up the format right? so it's less likely to trigger merge conflicts (it's all in one line, so everything always conflicts)
i'll have to look at what the conflicts actually look like, it's certainly plausible that pretty formatting of that file will avoid most conflicts
can we expand on "the way we deploy through netlify" ? presumably netlify is reacting to changes in a static committed file or something?
[build]
command = "yarn run docusaurus build"
that's what our docs build looks like - anything that's not built by that command is built and committed to the repo
The way we build the PHP docs is in the docs Dagger module and published to directory that gets grabbed by the netlify deploy: https://github.com/dagger/dagger/blob/b2fc95bef83bbdf9fb05d5dc0ede8f8c1055312e/docs/.dagger/main.go#L188