Skip to content

Various documentation enhancements #1728

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
May 6, 2025
Merged

Various documentation enhancements #1728

merged 11 commits into from
May 6, 2025

Conversation

bkoelman
Copy link
Member

@bkoelman bkoelman commented May 5, 2025

This PR contains various improvements to the documentation website:

  • Document public types in the OpenAPI package and show them in API Explorer
  • Replace docfx logo with our own
  • Enable Google Analytics
  • Add redirects for changed APIs (based on 404s from Google Search Console)
  • Convert TOCs from Markdown to Yaml format
  • Fix caching during local build of the website
  • List the example projects in the documentation
  • Expand the list of commonly-used types on the API Browser index page
  • Add Advanced section in Usage that describes features covered by integration tests
  • Consolidate Getting Started to point to the steps in the repo README
  • Add GitHub icon in the menu bar

QUALITY CHECKLIST

Copy link

codecov bot commented May 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.78%. Comparing base (fe38678) to head (8dae382).
Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1728   +/-   ##
=======================================
  Coverage   90.78%   90.78%           
=======================================
  Files         467      467           
  Lines       14615    14615           
  Branches     2302     2302           
=======================================
  Hits        13268    13268           
  Misses        917      917           
  Partials      430      430           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bkoelman bkoelman marked this pull request as ready for review May 5, 2025 16:55
@bkoelman bkoelman merged commit b21cf5c into master May 6, 2025
16 checks passed
@bkoelman bkoelman deleted the docs-various branch May 6, 2025 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

1 participant