Expansion of docs for making a new database #157
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR expands and refines the documentation on how to use the AstroDB template for creating a new database. Key changes include:
- Updating the title and formatting of the template schema documentation.
- Removing a redundant documentation page.
- Expanding and revising the “Getting Started” documentation with detailed setup steps and improved toctree settings.
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| docs/pages/template_schema/template_schema.rst | Updated title and header to clarify the template schema. |
| docs/pages/make_new_db/the_template_schema.rst | Removed duplicate documentation for the template schema. |
| docs/pages/make_new_db/modifying_schema.rst | Adjusted header underline formatting for the guidelines section. |
| docs/pages/make_new_db/getting_started_new_database.rst | Expanded step-by-step instructions and updated toctree options. |
There was a problem hiding this comment.
Pull Request Overview
This PR expands and refines the documentation for creating a new database using the AstroDB template.
- Updates the main template schema page title and formatting
- Removes a redundant schema page
- Fixes heading underlines in the “modifying_schema” guide
- Enhances the “Getting Started” guide with detailed, numbered steps and toctree options
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| docs/pages/template_schema/template_schema.rst | Updated title to “The AstroDB Template schema” |
| docs/pages/make_new_db/the_template_schema.rst | Removed redundant content, leaving the file empty |
| docs/pages/make_new_db/modifying_schema.rst | Corrected underline lengths on several section headers |
| docs/pages/make_new_db/getting_started_new_database.rst | Expanded setup steps, added toctree options |
Comments suppressed due to low confidence (1)
docs/pages/make_new_db/the_template_schema.rst:1
- This file is now empty after removing its content; consider deleting it from the repo to avoid an orphaned file.
-The template schema
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR expands and clarifies the documentation for using the AstroDB Template schema and making a new database. Key changes include an updated header in the Template Schema page, removal of duplicate content from an outdated file, and adjustments to section header underlines and toctree options across several documentation pages.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/pages/template_schema/template_schema.rst | Updated header to "The AstroDB Template schema" for improved clarity. |
| docs/pages/make_new_db/the_template_schema.rst | Removed duplicate template schema page. |
| docs/pages/make_new_db/modifying_schema.rst | Modified section headers (Philosophy and guidelines, Column names, and Units) with updated underline styles. |
| docs/pages/make_new_db/getting_started_new_database.rst | Revised toctree options and ordered list steps to enhance the new database creation guide. |
| docs/pages/ingesting/spectra/index.rst | Added toctree options for clearer spectra page organization. |
| docs/pages/ingesting/getting_started_ingesting.rst | Updated toctree options and API documentation section headers for consistency. |
There was a problem hiding this comment.
Pull Request Overview
This PR expands and refines the documentation related to creating and modifying a new database. Key changes include:
- Renaming and restyling of headers in the template and modifying schema pages.
- Removal of the duplicate "the_template_schema" file and updating of toctree references.
- Enhanced instructions and formatting improvements in the getting started and ingesting documentation pages.
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/pages/template_schema/template_schema.rst | Updated header text and style for clarity. |
| docs/pages/make_new_db/the_template_schema.rst | Removed duplicate documentation and streamlined file references. |
| docs/pages/make_new_db/modifying_schema.rst | Standardized section headers and formatting for better readability. |
| docs/pages/make_new_db/getting_started_new_database.rst | Reformatted toctree and ordered list instructions for clarity. |
| docs/pages/ingesting/spectra/index.rst | Added toctree options to improve navigation. |
| docs/pages/ingesting/getting_started_ingesting.rst | Enhanced toctree and API Documentation details with improved formatting. |
Comments suppressed due to low confidence (2)
docs/pages/make_new_db/the_template_schema.rst:1
- [nitpick] The removal of this file seems intended to reduce duplicate documentation. Please ensure that all references to the removed 'the_template_schema' have been updated accordingly.
-The template schema
docs/pages/make_new_db/modifying_schema.rst:33
- [nitpick] Consider verifying that the underline length exactly matches the header text for consistency in reStructuredText formatting.
-------------------------
|
|
||
| * Please retain the credit line to the AstroDB Toolkit. | ||
|
|
||
| #. Update the ``LICENSE`` file with your license of choice. |
There was a problem hiding this comment.
does our license require that they use any specific license?
There was a problem hiding this comment.
Opened a new issue for this topic.
Inspired by work with @easton-honaker, here's some more words on how to use the Template.