You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Please verify the version of wc-generator you have installed
4.6.2
Please describe the bug
The new documentation processor in Auro Library operates on files after they've been copied into their destination instead of operating before and then inserting the modified file contents into the destination. I've outlined the process below for the README file.
Old flow for README:
User runs build:docs
Script fetches latest README
Script runs markdown magic on docTemplates/README.md
Script outputs content into /README.md
New flow for README:
User runs build:docs
Script fetches latest README
Script copies README to /README.md, overwriting what's already there
Script runs markdown magic AND variable replacement on /README.md, writing contents to file
Reproducing the error
None
Expected behavior
Readme's markdown magic comments should point to partials as if reading from the root of the repository, not from /docTemplates
What browsers are you seeing the problem on?
No response
Additional context
This is a little confusing at first, like WHY would you do this?
The simple answer is, we want to be able to use this for any file in any Auro repository. The end user should be able to easily sus out pathing to partial files from the destination directory, as that's where the file seems to live.
Exit criteria
No response
The text was updated successfully, but these errors were encountered:
Please verify the version of wc-generator you have installed
4.6.2
Please describe the bug
The new documentation processor in Auro Library operates on files after they've been copied into their destination instead of operating before and then inserting the modified file contents into the destination. I've outlined the process below for the README file.
Old flow for README:
build:docs
docTemplates/README.md
/README.md
New flow for README:
build:docs
/README.md
, overwriting what's already there/README.md
, writing contents to fileReproducing the error
None
Expected behavior
Readme's markdown magic comments should point to partials as if reading from the root of the repository, not from
/docTemplates
What browsers are you seeing the problem on?
No response
Additional context
This is a little confusing at first, like WHY would you do this?
The simple answer is, we want to be able to use this for any file in any Auro repository. The end user should be able to easily sus out pathing to partial files from the destination directory, as that's where the file seems to live.
Exit criteria
No response
The text was updated successfully, but these errors were encountered: