Skip to content

Comments

Stage Dev Documentation #212

Merged
justincorrigible merged 62 commits intomainfrom
bridgeStage
Feb 5, 2025
Merged

Stage Dev Documentation #212
justincorrigible merged 62 commits intomainfrom
bridgeStage

Conversation

@MitchellShiell
Copy link
Contributor

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

Important

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

🫵 To Review

@MitchellShiell MitchellShiell marked this pull request as ready for review October 9, 2024 16:09

This command will set up all complementary services for Stage development as follows:

![Stage Dev](./assets/stageDev.svg 'Stage Dev Environment')

Choose a reason for hiding this comment

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

Same image is used in Overview so I'm wondering whether if it's really needed twice?

Copy link
Member

@justincorrigible justincorrigible left a comment

Choose a reason for hiding this comment

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

great work overall. all the user documentation is looking amazing across Overture! 👏
left a couple suggestions, and as always would be open to discuss if you disagree with anything!

unrelated note: rebased the branch to bring some pipeline changes, seeking to fix the failing build checks (edit: it worked)

MitchellShiell and others added 8 commits November 26, 2024 16:39
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
Co-authored-by: Anders Richardsson <2107110+justincorrigible@users.noreply.github.com>
@justincorrigible justincorrigible merged commit d993732 into main Feb 5, 2025
@justincorrigible justincorrigible deleted the bridgeStage branch February 5, 2025 21:41
@justincorrigible justincorrigible restored the bridgeStage branch February 5, 2025 21:42
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