Conversation
7e6cbaf to
74864c0
Compare
|
No not yet. You are right, we should merge both of them at the same time. Let me rebase #285 onto this branch. Then we can merge it in here and push both book and new install scripts at once. |
I see the website/init file in the diff now, while reviewing. It exists and looks to be placed in the correct spot, but it is still the old version. We will have to figure out how to get latest working correctly only once 0.32.0 is released, but I think we can manage. |
|
ah, right. I forgot that I also added it here already. This means this PR is independent from #285 and should not break anything regarding the installation script. |
micprog
left a comment
There was a problem hiding this comment.
I think there are some points to address... I have not checked the README (I want to ensure all content previously covered within is properly covered in the book) and the commands (I want to ensure all are present), but figured I'd share the comments I already have.
| @@ -0,0 +1 @@ | |||
| book No newline at end of file | |||
| - **[Inspecting Source Files](./workflow/sources.md):** Exploring and filtering the source files in your project. | ||
| - **[Generating Tool Scripts](./workflow/scripts.md):** Creating compilation and simulation scripts for various EDA tools. | ||
| - **[Package Development](./workflow/package_dev.md):** Developing multiple packages simultaneously using the `clone` and `snapshot` flow. | ||
| - **[Vendorizing External Code](./workflow/vendor.md):** Managing external repositories that don't natively support Bender. |
There was a problem hiding this comment.
Did we want to add the ci section here as well, or is this linked elsewhere?
| @@ -0,0 +1,54 @@ | |||
| name: Deploy Documentation | |||
There was a problem hiding this comment.
Is this flow tested somewhere (e.g., on a temporary fork)? Just to ensure there are no issues here.
|
|
||
| ```sh | ||
| bender script template --template my_custom_format.tera > output.txt | ||
| ``` |
There was a problem hiding this comment.
To assist in development, bender can dump the json it provides to the template using bender script template_json
|
|
||
| Bender's `vendor` command allows you to manage external dependencies that aren't natively packaged for Bender. It works by copying a subset of files from an upstream Git repository into a local directory within your project, allowing you to track changes and maintain local patches. | ||
|
|
||
| This flow is heavily inspired by the `vendor.py` script used in the [OpenTitan](https://opentitan.org/) project. |
There was a problem hiding this comment.
Can we add a direct link to the script?
| ``` | ||
|
|
||
| Bender clones the upstream repository, filters the files based on your rules, and copies them to your project. If a `patch_dir` is specified, any existing patches are applied automatically. | ||
|
|
There was a problem hiding this comment.
Can we add a note or some information here (or in a better spot) that the files listed in vendor are not automatically included as source files for the bender project! These need to be additionally specified in the source list in the manifest!
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
Co-authored-by: Michael Rogenmoser <michael@rogenmoser.us>
TODOs
Change structure maybe? Putbook.tomlin root directoryAlignMention in installer: replaceinitwith version-aware router #285,removewebsitebranchcommandssectionsourcesworkflow?websiteto "Github Actions"