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

Lyric Dev Documentation #106

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open

Lyric Dev Documentation #106

wants to merge 20 commits into from

Conversation

MitchellShiell
Copy link

@MitchellShiell MitchellShiell commented Oct 22, 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

The Overview Page can be seen here

Setup will be added next (but not included in this round)

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

Important

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

@MitchellShiell MitchellShiell marked this pull request as ready for review October 24, 2024 14:14
Copy link
Contributor

@joneubank joneubank left a comment

Choose a reason for hiding this comment

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

Great stuff!

@MitchellShiell MitchellShiell changed the title [WIP] - Lyric Dev Documentation Lyric Dev Documentation Nov 2, 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.

3 participants