janhoy commented on code in PR #4716: URL: https://github.com/apache/solr/pull/4716#discussion_r3731973844
########## AGENTS.md: ########## @@ -51,6 +51,26 @@ While README.md and CONTRIBUTING.md are mainly written for humans, this file is - New classes should have some javadocs - Changes should not have code comments communicating the change, which are instead great comments to leave for code review / commentary +## Developer Docs Index + +Before diving into code on these topics, read the matching doc in `dev-docs/`. When adding a new dev doc, add a line here. + +Internals: + +- `dev-docs/overseer/overseer.adoc` — Overseer: cluster state updates, ZkStateWriter, collection API message flow Review Comment: This new section looks very useful for agents, like a "map" of where to read more on dev topics. I like it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
