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

Stage Dev Documentation #212

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

Stage Dev Documentation #212

wants to merge 60 commits into from

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


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?

docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
docs/overview.md Outdated Show resolved Hide resolved
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)

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