Skip to content

Add documentation on output files (new page), add links to maritime s… - #72

Merged
StephanieKemna merged 1 commit into
devfrom
71-add-example-output-to-documentation
Sep 23, 2025
Merged

Add documentation on output files (new page), add links to maritime s…#72
StephanieKemna merged 1 commit into
devfrom
71-add-example-output-to-documentation

Conversation

@StephanieKemna

Copy link
Copy Markdown
Collaborator

…chema, add links to input/output file pages from usage page

Resolves #71

…chema, add links to input/output file pages from usage page
@StephanieKemna StephanieKemna self-assigned this Sep 23, 2025
@StephanieKemna StephanieKemna added the documentation Improvements or additions to documentation label Sep 23, 2025

Copilot AI left a comment

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.

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.rst page 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.

@tomarnepedersen tomarnepedersen left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good

@StephanieKemna
StephanieKemna merged commit ee3f83d into dev Sep 23, 2025
8 checks passed
@StephanieKemna
StephanieKemna deleted the 71-add-example-output-to-documentation branch September 23, 2025 09:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants