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

docs: fix broken npm run watch:docs #2841

Open
wants to merge 3 commits into
base: next
Choose a base branch
from

Conversation

tbreuss
Copy link
Contributor

@tbreuss tbreuss commented May 6, 2023

Fixes #2840.

Since the behaviour of the current script was not so obvious, I set the requirements as follows and edited the script therefore.

If the layout.html was deleted:

  • throw error "Error: the layout "layout.html" file is required!"

If the layout.html was updated:

  • loads the layout file and regenerates all html files in dist

If a navigation file (nav-guides.md|nav-methods.md) was deleted:

  • throw error "Error: the navigation file "nav-guides.md" is required!"

If a navigation file was updated:

  • loads the navigation files and regenerates all pages in dist

If a markdown file was deleted:

  • deletes the html page from dist

If a markdown file was updated:

  • regenerates the html page in dist

If a markdown file was added:

  • generates the html page in dist

If an asset file was deleted:

  • deletes the asset file from dist

If an asset file was updated:

  • updates the asset file in dist

If an asset file was added:

  • adds the asset file to dist

@tbreuss tbreuss changed the title docs: fix broken npm watch:docs docs: fix broken npm run watch:docs May 6, 2023
Copy link
Member

@dead-claudia dead-claudia left a comment

Choose a reason for hiding this comment

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

Bit too accidentally parallel.

scripts/generate-docs.js Outdated Show resolved Hide resolved
scripts/generate-docs.js Outdated Show resolved Hide resolved
scripts/generate-docs.js Outdated Show resolved Hide resolved
scripts/generate-docs.js Outdated Show resolved Hide resolved
@tbreuss
Copy link
Contributor Author

tbreuss commented May 7, 2023

@dead-claudia I fixed all code review issues.

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

Successfully merging this pull request may close these issues.

Script "npm run watch:docs" is broken
2 participants