dimas-b commented on code in PR #1879: URL: https://github.com/apache/polaris/pull/1879#discussion_r2141350230
########## README.md: ########## @@ -25,8 +25,8 @@ enabling seamless multi-engine interoperability across a wide range of platforms Apache Spark™, StarRocks, and Trino. Documentation is available at https://polaris.apache.org, including -[Polaris management API doc](https://polaris.apache.org/index.html#tag/polaris-management-service_other) -and [Apache Iceberg REST API doc](https://polaris.apache.org/index.html#tag/Configuration-API). +[Polaris management API doc](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/apache/polaris/refs/heads/main/spec/polaris-management-service.yml) +and [Polaris Catalog API doc](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/apache/polaris/refs/heads/main/spec/generated/bundled-polaris-catalog-service.yaml). Review Comment: While the new links work, the overall statement becomes somewhat confusing. The first part states that documentation is available on the `polaris.apache.org` site, but the two following links point to `swagger.io`. There is not technical problem there, but from the UX perspective I think it is preferable to avoid taking the reader to a web site that differs from what the reader is lead to believe to be the destination. -- 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: issues-unsubscr...@polaris.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
