binarycat0 opened a new pull request, #2598: URL: https://github.com/apache/polaris/pull/2598
create docs/polaris-api-specs mv docs/polaris-management-service.md-> docs/polaris-api-specs/polaris-management-api.md mv docs/polaris-catalog-service.md -> docs/polaris-api-specs/polaris-catalog-api.md ---- ## Goal: Improve the convenience and usability of project documentation. ### Old documentation view: Menu items are external links, which is inconvenient when studying documentation - each time you navigate to another menu item, a third-party link opens. Also, both sections essentially belong to the API work category. - Management OpenAPI - Catalog API Spec <img width="1678" height="855" alt="Screenshot 2025-09-17 at 15 16 46" src="https://github.com/user-attachments/assets/4c440e97-be61-4772-8461-2b843913138c"; /> ### New documentation variant: An additional "Polaris API Reference" section has been created where the two external API specification links are placed. A visual element has also been added to emphasize that these menu items are external links. The new variant is much more convenient for perception. - Polaris API Reference - Management API ↗ - Catalog API ↗ <img width="1678" height="855" alt="Screenshot 2025-09-17 at 15 08 57" src="https://github.com/user-attachments/assets/ccc2ceb1-da5a-4c90-a0ac-a5c03c342e8a"; /> <!-- Possible security vulnerabilities: STOP here and contact [email protected] instead! Please update the title of the PR with a meaningful message - do not leave it "empty" or "generated" Please update this summary field: The summary should cover these topics, if applicable: * the motivation for the change * a description of the status quo, for example the current behavior * the desired behavior * etc PR checklist: - Do a self-review of your code before opening a pull request - Make sure that there's good test coverage for the changes included in this PR - Run tests locally before pushing a PR (./gradlew check) - Code should have comments where applicable. Particularly hard-to-understand areas deserve good in-line documentation. - Include changes and enhancements to the documentation (in site/content/in-dev/unreleased) - For Work In Progress Pull Requests, please use the Draft PR feature. Make sure to add the information BELOW this comment. Everything in this comment will NOT be added to the PR description. --> -- 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]
