Skip to content

Song Dev Documentation - #857

Merged
MitchellShiell merged 44 commits into
developfrom
bridgeSong
Feb 7, 2025
Merged

MitchellShiell merged 44 commits into
developfrom
bridgeSong

Conversation

@MitchellShiell

@MitchellShiell MitchellShiell commented Sep 17, 2024 •

Copy link
Copy Markdown
Contributor

The branch is linked and rendered on a single, easy-to-navigate developer hub that beautifully renders all our product documentation from the /docs folder of all our GitHub repositories.

  • An updated Readme.md file.
  • A /docs folder with the following basic structure:
.
├── /overview
└── /setup

Usage will be added next (but not included in this round of review)

  • An updated contributing file
  • An updated code_of_conduct file
  • An updated license.md file
  • An updated Application.yaml file

Usage Content

  • Submitting data
  • Retrieving data
  • Updating data
  • Publication Controls
  • Data Model Management
  • API Reference
  • Command reference

Important

Before going live will need to update any links to the demo discussion board and Netlify deploy preview

To Review

Important

Please review the current Song Readme, is there any information, methods, or setups we would like to keep and capture in this documentation update? (i.e building song-client from source)

@MitchellShiell MitchellShiell changed the title [WIP] - Score Documentation Update [WIP] - Song Documentation Update Sep 17, 2024
@MitchellShiell MitchellShiell changed the title [WIP] - Song Documentation Update [WIP] - Song Dev Documentation Sep 27, 2024
@MitchellShiell
MitchellShiell marked this pull request as ready for review October 9, 2024 16:09
@MitchellShiell MitchellShiell mentioned this pull request Nov 1, 2024
24 of 29 tasks
@MitchellShiell MitchellShiell changed the title [WIP] - Song Dev Documentation Song Dev Documentation Nov 5, 2024

@joneubank joneubank 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.

LGMT 🐢 !

@MitchellShiell
MitchellShiell merged commit d7e5cb6 into develop Feb 7, 2025
@MitchellShiell
MitchellShiell deleted the bridgeSong branch February 7, 2025 14:29
@MitchellShiell
MitchellShiell restored the bridgeSong branch February 7, 2025 14:29
@joneubank joneubank mentioned this pull request May 29, 2025
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.

3 participants