flyingImer opened a new pull request, #4368: URL: https://github.com/apache/polaris/pull/4368
New contributors (human and AI) spend real time building a mental map of Polaris's modules before they can make a focused change. The [Code Wiki for Apache Polaris](https://codewiki.google/github.com/apache/polaris) is a third-party, auto-generated overview of modules and their relationships that can shorten that ramp-up. This PR links it from the three documents that onboarding readers actually open: `README.md`, `CONTRIBUTING.md`, and `AGENTS.md`. Framing decisions: - The Code Wiki is described as a navigation aid, not authoritative. The source tree remains the ground truth, so readers are told to verify against the source before relying on it for design decisions. - `CONTRIBUTING.md` holds the canonical blurb under a new `### Get oriented in the codebase` subsection. - `README.md` carries a parallel short paragraph near the existing docs reference, since the README is the public entry point. - `AGENTS.md` links back to the `CONTRIBUTING.md` section rather than duplicating the guidance. Scope: docs only. No site/ content, no extension to dependencies; those can be follow-ups if the link proves useful. Follow-up to #4276. Motivated by [apache/polaris#1028 (comment)](https://github.com/apache/polaris/discussions/1028#discussioncomment-16819321). ## Checklist - [x] ๐ก๏ธ Don't disclose security issues! (contact [email protected]) - [x] ๐ Clearly explained why the changes are needed, or linked related issues: follow-up to #4276 - [x] ๐งช Added/updated tests with good coverage, or manually tested (and explained how): N/A (documentation only) - [x] ๐ก Added comments for complex logic: N/A - [ ] ๐งพ Updated \`CHANGELOG.md\` (if needed): not needed for docs-only - [ ] ๐ Updated documentation in \`site/content/in-dev/unreleased\` (if needed): not needed -- 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]
