Add documentation on output files (new page), add links to maritime s… - #72
Merged
Merged
Conversation
…chema, add links to input/output file pages from usage page
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for output files by creating a new dedicated page and improves navigation between related documentation sections. The changes resolve issue #71 by documenting the maritime schema format used for output files and adding cross-references.
- Creates a new
output_files.rstpage with detailed documentation and example JSON output - Adds cross-reference links between input/output file pages and the usage page
- Restructures the usage page to better organize input and output information
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/output_files.rst | New documentation page explaining output file format with maritime schema links and example JSON |
| docs/source/usage.rst | Updated to add cross-references and reorganize input/output sections |
| docs/source/input_files.rst | Added reference label for cross-linking |
| docs/source/index.rst | Added new output_files page to table of contents |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
…chema, add links to input/output file pages from usage page
Resolves #71