Skip to content

Conversation

@Millu
Copy link
Contributor

@Millu Millu commented Jul 19, 2023

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update

Have you discussed this change with the InvokeAI team?

  • Yes
  • No, because: documentation update that needs review from the team before going live

Description

I updated the contribution guidelines, adding more structure and a getting started guide. Also re-organized the tabs to be in the order of most commonly used.

Related Tickets & Documents

  • Related Issue #
  • Closes #

QA Instructions, Screenshots, Recordings

run mkdocs serve to check it out

Added/updated tests?

  • Yes
  • [X ] No : please replace this line with details on why tests
    have not been included

[optional] Are there any post deployment tasks we need to perform?

* Updated nav to be in new order prioritizing more commonuly used tabs
* Added set nav in mkdocs.yaml
@psychedelicious
Copy link
Contributor

Should we integrate this doc? docs/contributing/LOCAL_DEVELOPMENT.md

• Updated index with new contribution guide link
@Millu
Copy link
Contributor Author

Millu commented Jul 19, 2023

Should we integrate this doc? docs/contributing/LOCAL_DEVELOPMENT.md

Updated to include best practices and this

Copy link
Collaborator

@lstein lstein left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! A few suggestions noted above.

@Millu
Copy link
Contributor Author

Millu commented Jul 19, 2023

@lstein thank you for the feedback! Just updated everything

Copy link
Collaborator

@lstein lstein left a comment

Choose a reason for hiding this comment

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

Very nice! Thank you.

@Millu
Copy link
Contributor Author

Millu commented Jul 20, 2023

@blessedcoolant all changes have been made!

@blessedcoolant
Copy link
Collaborator

@blessedcoolant all changes have been made!

Sweet thanks. Seems good to me. Can't spot anything obvious that needs updating. Some links are broken coz some docs are missing (unrelated to the PR) but I'm guessing that is expected?

Feel free to merge when you like. All good.

@Millu Millu merged commit 82554b2 into invoke-ai:main Jul 20, 2023
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.

4 participants