Skip to content

docs: tidy and correct top-level README#4427

Merged
flyrain merged 1 commit into
apache:mainfrom
flyrain:docs/readme-tidy
May 15, 2026
Merged

docs: tidy and correct top-level README#4427
flyrain merged 1 commit into
apache:mainfrom
flyrain:docs/readme-tidy

Conversation

@flyrain

@flyrain flyrain commented May 13, 2026

Copy link
Copy Markdown
Contributor
  • Reorganize Project Structure into flat module groups (Core, API, Runtime, Persistence, Extensions, Tooling, Tests) and add modules that were missing from the list (e.g. polaris-runtime-common, federation bigquery, auth opa/ranger, hms-testcontainer).
  • Fix typo: agregated-license-report -> aggregated-license-report.
  • Merge the thin Overview and Quickstart sections.
  • Trim the Develocity build-scans section to the essentials.
  • Normalize trademark glyphs to HTML entities and drop trailing whitespace.

Checklist

  • 🛡️ Don't disclose security issues! (contact security@apache.org)
  • 🔗 Clearly explained why the changes are needed, or linked related issues: Fixes #
  • 🧪 Added/updated tests with good coverage, or manually tested (and explained how)
  • 💡 Added comments for complex logic
  • 🧾 Updated CHANGELOG.md (if needed)
  • 📚 Updated documentation in site/content/in-dev/unreleased (if needed)

- Reorganize Project Structure into flat module groups (Core, API,
  Runtime, Persistence, Extensions, Tooling, Tests) and add modules that
  were missing from the list (e.g. polaris-runtime-common, federation
  bigquery, auth opa/ranger, hms-testcontainer).
- Fix typo: agregated-license-report -> aggregated-license-report.
- Merge the thin Overview and Quickstart sections.
- Trim the Develocity build-scans section to the essentials.
- Normalize trademark glyphs to HTML entities and drop trailing
  whitespace.
@github-project-automation github-project-automation Bot moved this from PRs In Progress to Ready to merge in Basic Kanban Board May 14, 2026
@flyrain
flyrain merged commit a0a99ad into apache:main May 15, 2026
24 checks passed
@github-project-automation github-project-automation Bot moved this from Ready to merge to Done in Basic Kanban Board May 15, 2026
@flyrain

flyrain commented May 15, 2026

Copy link
Copy Markdown
Contributor Author

Thanks for the review, @MonkeyCanCode !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants