Skip to content

Reorganizing docs#233

Open
dr-rodriguez wants to merge 8 commits intoastrodbtoolkit:mainfrom
dr-rodriguez:doc-updates
Open

Reorganizing docs#233
dr-rodriguez wants to merge 8 commits intoastrodbtoolkit:mainfrom
dr-rodriguez:doc-updates

Conversation

@dr-rodriguez
Copy link
Copy Markdown
Collaborator

@dr-rodriguez dr-rodriguez commented Feb 3, 2026

This reorganizes the documentation into a smaller set of top-level directories to guide the user to typical tasks.

@dr-rodriguez dr-rodriguez requested a review from kelle February 3, 2026 21:17
@dr-rodriguez dr-rodriguez self-assigned this Feb 3, 2026
@dr-rodriguez dr-rodriguez added the documentation Documentation for using astrodb_utils or the template, including making a new database. label Feb 3, 2026
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 72.62%. Comparing base (de048fd) to head (d500968).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #233      +/-   ##
==========================================
+ Coverage   71.32%   72.62%   +1.29%     
==========================================
  Files          19       19              
  Lines        1653     1673      +20     
  Branches      210      211       +1     
==========================================
+ Hits         1179     1215      +36     
+ Misses        387      376      -11     
+ Partials       87       82       -5     

☔ 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.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I wasn't sure: is this still valid or out of date? I had to move the template_schema to a subdirectory

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Out of date. The docs/conf.py now looks for the template_db and clones it if it doesn't exist.

@dr-rodriguez dr-rodriguez marked this pull request as ready for review February 3, 2026 22:22
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change

Updated documentation to clarify submodule non-usage.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Documentation for using astrodb_utils or the template, including making a new database.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants