Skip to content
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

initial rewrite #4149

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

initial rewrite #4149

wants to merge 4 commits into from

Conversation

drernie
Copy link
Member

@drernie drernie commented Sep 19, 2024

Description

Reorganize the SUMMARY document to:

  1. Refactor content by use case
  2. Prioritize Catalog user documentation over developer APIs
  3. Match our new product terminology

Copy link

codecov bot commented Sep 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 38.16%. Comparing base (fb3a344) to head (7bd14a9).

Additional details and impacted files
@@           Coverage Diff            @@
##           master    #4149    +/-   ##
========================================
  Coverage   38.16%   38.16%            
========================================
  Files         725      725            
  Lines       33505    33505            
  Branches     4960     4782   -178     
========================================
  Hits        12786    12786            
- Misses      19551    20095   +544     
+ Partials     1168      624   -544     
Flag Coverage Δ
api-python 90.85% <ø> (ø)
catalog 11.32% <ø> (ø)
lambda 87.95% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@drernie
Copy link
Member Author

drernie commented Sep 19, 2024

The goal of this PR is simply to fix the SUMMARY without changing the content.
Cleaning up the actual documents to align with this new structure is a follow-on task (suggestions welcome).

Copy link

@QuiltSimon QuiltSimon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the recommendation we put together. Looks good to me.

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