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

started the burn developer book #1184

Merged
merged 33 commits into from Feb 5, 2024

Conversation

skewballfox
Copy link
Contributor

@skewballfox skewballfox commented Jan 26, 2024

Pull Request Template

Checklist

  • Confirmed that run-checks all script has been executed.
  • Made sure the book is up to date with changes in this PR.

Related Issues/PRs

None

Changes

Adds a book that is geared toward contributors to burn. I haven't moved any of the existing content yet (such as Architecture.md, burn-import/contributing.md) as I'm not sure what files should me moved or just copied/modified.

Testing

I ran mdbook build --open locally to confirm that the book does in fact build.
I read it, to confirm it is indeed readable

jokes aside, if we keep the style guidelines, should we try to run any checks to see if linked code is still exists or the current information is still up to date with main?

@skewballfox skewballfox marked this pull request as draft January 26, 2024 17:42
Copy link

codecov bot commented Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (4aa13d6) 84.42% compared to head (6d9c783) 84.37%.
Report is 15 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1184      +/-   ##
==========================================
- Coverage   84.42%   84.37%   -0.05%     
==========================================
  Files         549      550       +1     
  Lines       61921    62198     +277     
==========================================
+ Hits        52278    52482     +204     
- Misses       9643     9716      +73     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@antimora
Copy link
Collaborator

Quick feedback re formatting (haven't read the content in details yet).

I recommend you format the text using something like prettier if you have a VS/Neovim plug-in. We have a configuration for prettier: https://github.com/tracel-ai/burn/blob/main/burn-book/.prettierrc.json (or you can define yours)

This helps formatting tables and wrapping markdown text.

Copy link
Member

@nathanielsimard nathanielsimard left a comment

Choose a reason for hiding this comment

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

These are just some general comments since this is still a work in progress.

I've commented on some typos, but since it's a draft, maybe you haven't checked them all, there are more to fix. I suggest adopting a more objective tone overall, but the content is good!

contributor-book/book.toml Outdated Show resolved Hide resolved
contributor-book/src/getting-started/testing.md Outdated Show resolved Hide resolved
contributor-book/src/SUMMARY.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@antimora antimora left a comment

Choose a reason for hiding this comment

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

Thank you for starting this contributor book.

Once, you're completed and merge it, I'll add a couple of section as well:

  1. https://github.com/tracel-ai/burn/blob/main/burn-import/DEVELOPMENT.md
  2. import from other formats.

contributor-book/src/SUMMARY.md Outdated Show resolved Hide resolved
@skewballfox skewballfox marked this pull request as ready for review January 29, 2024 13:08
Copy link
Member

@syl20bnr syl20bnr left a comment

Choose a reason for hiding this comment

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

I did a first pass on the beginning of the PR with some recommendations and some typo fixes, I will do a complete proof-read for typos later.

That's an awesome PR. 👍

contributor-book/book.toml Show resolved Hide resolved
contributor-book/src/getting-started/testing.md Outdated Show resolved Hide resolved
contributor-book/src/getting-started/testing.md Outdated Show resolved Hide resolved
contributor-book/src/getting-started/testing.md Outdated Show resolved Hide resolved
@skewballfox skewballfox mentioned this pull request Jan 30, 2024
2 tasks
@antimora antimora added the documentation Improvements or additions to documentation label Jan 31, 2024
@antimora
Copy link
Collaborator

I re-requested reviews again for approvals. I'll check it now again.

One outstanding is to fix the conflicting file.

Copy link
Collaborator

@antimora antimora left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for starting and filling up this book!

Copy link
Member

@syl20bnr syl20bnr left a comment

Choose a reason for hiding this comment

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

Made an entire pass to essentially fix typos.

contributor-book/src/overview.md Outdated Show resolved Hide resolved
contributor-book/src/overview.md Outdated Show resolved Hide resolved
contributor-book/src/project-architecture/Tensor.md Outdated Show resolved Hide resolved
contributor-book/src/project-architecture/module.md Outdated Show resolved Hide resolved
contributor-book/src/project-architecture/module.md Outdated Show resolved Hide resolved
Copy link
Member

@syl20bnr syl20bnr left a comment

Choose a reason for hiding this comment

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

Awesome work !
Thanks for fixing the path to the Contributor book in the xtask command 😊

Copy link
Member

@nathanielsimard nathanielsimard left a comment

Choose a reason for hiding this comment

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

👏

@nathanielsimard nathanielsimard merged commit 3eab141 into tracel-ai:main Feb 5, 2024
14 checks passed
@skewballfox
Copy link
Contributor Author

There a URL for it yet?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants