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

Rename and reform Installation section #161

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Rename and reform Installation section #161

wants to merge 2 commits into from

Conversation

PabRod
Copy link
Collaborator

@PabRod PabRod commented May 29, 2024

Closes #147

Checklist

The section is now called Usage. The section text is now more reader-friendly
@PabRod PabRod requested a review from abelsiqueira May 29, 2024 11:56
@PabRod PabRod added this to the 0.5.0 - Hack & Feed 1 milestone May 29, 2024
Copy link
Owner

@abelsiqueira abelsiqueira left a comment

Choose a reason for hiding this comment

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

Hi @PabRod, I noticed now that you asked for review, but I see that it's a draft and it's incomplete, so I'm not sure. Either way, I made a short comment.

Overall, I'm moving fast and breaking things, so this PR will have conflicts soon. Maybe, instead of working on the PR directly, you could mention some of the reasoning in #147. So I know where to put it in the planning.

docs/src/10-full-guide.md Outdated Show resolved Hide resolved
@PabRod
Copy link
Collaborator Author

PabRod commented Jun 5, 2024

Overall, I'm moving fast and breaking things, so this PR will have conflicts soon.

This is a classic problem when working on documentation. My suggestion: just merge whatever we have, and I'll reopen a new PR when I make further changes in the docs.

Co-authored-by: Abel Soares Siqueira <[email protected]>
@abelsiqueira abelsiqueira removed this from the 0.5.0 - Apply to existing milestone Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Documentation improvements to the full guide
2 participants