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

[auro-library integration] Remote README template needs updated relative pathing #582

Closed
DukeFerdinand opened this issue Oct 16, 2024 · 0 comments · Fixed by #584
Closed
Assignees
Labels

Comments

@DukeFerdinand
Copy link
Contributor

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

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

Successfully merging a pull request may close this issue.

2 participants