Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Song Dev Documentation #857

Open
wants to merge 38 commits into
base: develop
Choose a base branch
from
Open

Song Dev Documentation #857

wants to merge 38 commits into from

Conversation

MitchellShiell
Copy link

@MitchellShiell MitchellShiell commented Sep 17, 2024

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 changed the title [WIP] - Song Dev Documentation Song Dev Documentation Nov 5, 2024
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.

1 participant