Update CT Contribution Guides - #483
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #483 +/- ##
==========================================
- Coverage 64.04% 64.04% -0.01%
==========================================
Files 76 76
Lines 10890 10890
==========================================
- Hits 6975 6974 -1
- Misses 3915 3916 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull Request Overview
This PR restructures and enhances the contribution documentation by removing outdated tutorial files, introducing dedicated guides for BTLx processing and joint contributions, and updating the main documentation index.
- Removed legacy tutorial files in
docs/tutorialsanddocs/examples - Added new guides under
docs/contributionfor BTLx and joint contributions - Updated
docs/index.rstto include the newcontributionsection
Reviewed Changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/tutorials/BTLx_contribution_guide.rst | Removed old BTLx contribution tutorial |
| docs/examples/create_joint.rst | Removed outdated create_joint example |
| docs/index.rst | Added contribution to the main ToC |
| docs/contribution/joints_contribution_guide.rst | Added new joint contribution guide |
| docs/contribution/BTLx_contribution_guide.rst | Added new BTLx contribution guide |
| docs/contribution.rst | Created root contribution guide with toctree |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…amaziokohler/compas_timber into update-btlx-contributionguide
obucklin
left a comment
obucklin
left a comment
There was a problem hiding this comment.
I left a couple of comments and suggestions. Minor clarifications. feel free to merge once you take a look.
LGTM
Co-authored-by: obucklin <55446042+obucklin@users.noreply.github.com>
Co-authored-by: obucklin <55446042+obucklin@users.noreply.github.com>
…into update-btlx-contributionguide
|
I just pushed some changes based on the comments of @obucklin and some afterthoughts I had about the Joint contribution guide. @chenkasirer would be nice to hear your thoughts on it too. |
chenkasirer
left a comment
chenkasirer
left a comment
There was a problem hiding this comment.
Looks great!
Added some suggestions, feel free to adopt or ignore at your discretion.
| 1. Identify the BTLx Processing and Parameters | ||
| ---------------------------------------------- | ||
|
|
||
| First, identify the specific BTLx processing you want to implement from the official BTLx specification: https://design2machine.com/btlx/btlx_2_1_0.pdf |
There was a problem hiding this comment.
do we support a specific version of the BTLx specification? honest question, I'm not entirely sure. maybe worth making it explicit.
There was a problem hiding this comment.
You are right to point that out.. I looked at the changelogs of the different versions and I haven't seen any changes that really affect us. Nevertheless I will update that to the latest version that anyway is the one that i am using as a reference. Do you think we should pin it to a specific version?
|
Did adjustments based on @chenkasirer comments. @obucklin feel free to review again or merge directly if you are also happy with the changes :) |
This is an attempt to update the contribution guides.
Although this is still a WIP I thought it would be good to get feedback already about this (joint contr. guide needs a bit more work).
Feel free to give input about content, formatting, style etc.
What type of change is this?
Checklist
Put an
xin the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.CHANGELOG.mdfile in theUnreleasedsection under the most fitting heading (e.g.Added,Changed,Removed).invoke test).invoke lint).compas_timber.datastructures.Beam.