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

3.1 Documentation Updates #4318

Merged
merged 23 commits into from
Aug 25, 2023
Merged

3.1 Documentation Updates #4318

merged 23 commits into from
Aug 25, 2023

Conversation

Millu
Copy link
Contributor

@Millu Millu commented Aug 18, 2023

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

  • Refactor
  • Feature
  • Bug Fix
  • Optimization
  • Documentation Update
  • Community Node Submission

Have you discussed this change with the InvokeAI team?

  • Yes
  • No, because:

Have you updated all relevant documentation?

  • Yes
  • No

Description

Related Tickets & Documents

  • Related Issue #
  • Closes #

QA Instructions, Screenshots, Recordings

Added/updated tests?

  • Yes
  • 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?

@Millu Millu marked this pull request as ready for review August 21, 2023 00:49
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.

I haven’t completely reviewed but here are suggestions for the diffusion overview and node editor docs.

docs/help/diffusion.md Outdated Show resolved Hide resolved
docs/help/diffusion.md Outdated Show resolved Hide resolved
docs/help/diffusion.md Show resolved Hide resolved
docs/help/diffusion.md Outdated Show resolved Hide resolved
docs/help/diffusion.md Show resolved Hide resolved
docs/nodes/NODES.md Outdated Show resolved Hide resolved
docs/nodes/NODES.md Outdated Show resolved Hide resolved
docs/nodes/NODES.md Outdated Show resolved Hide resolved
docs/nodes/NODES.md Outdated Show resolved Hide resolved
docs/nodes/NODES.md Outdated Show resolved Hide resolved
@Millu
Copy link
Contributor Author

Millu commented Aug 23, 2023

Thanks for the feedback @lstein! Docs have been updated to address it

@Millu Millu linked an issue Aug 23, 2023 that may be closed by this pull request
1 task
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.

Looks great!

Copy link
Collaborator

@blessedcoolant blessedcoolant left a comment

Choose a reason for hiding this comment

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

We've updated the design of the nodes a bit and probably might change a bit more .. but more importantly the order of the sockets have been updated. But that's not a blocker for this PR. Just something to note for docs so they're up to date.

Rest of it seems good to me.

We can either merge this now or we can do this at the very end when we are releasing so it can be fully be up to date.

Squash and merge or retain commit history?

@Millu
Copy link
Contributor Author

Millu commented Aug 25, 2023

@blessedcoolant I think squash & merge - no need to clutter the commit history with documentation tweaks IMO

I'll make a to-do for myself to get another PR for node updates before this is released

@Millu Millu merged commit 4ee65d1 into invoke-ai:main Aug 25, 2023
8 checks passed
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.

[bug]: Installation link points to 404
4 participants