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: remove auto-generated content #117
docs: remove auto-generated content #117
Conversation
Interesting, a few imports can't be resolved anymore, which means some of the auto-generated docs files weren't actually being generated anymore. No error had occurred before because those obsolete files were still available in the repo. |
I've removed unused/unresolvable imports for the map navigation component. But there's still the following error:
The auto-generated |
yep because the file is missing here: https://github.com/siemens/ix/blob/main/packages/angular-test-app/src/preview-examples I fix this asap |
The CI checks are passing now. 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
Summary
I've removed auto-generated content files in the documentation in the directory
packages/documentation/docs/auto-generated/*
because it's not necessary to version them via SCM and merely pollutes the repository. To prevent them from being added again in the future, I've added a.gitignore
file in the documentation package that excludes this path.See also #116 (comment).
How did you test this change?
There's not much to test. These files are generated by packages/documentation/scripts/generate-api.mjs which is run as part of the docs build process:
ix/packages/documentation/package.json
Line 8 in 67ff008
Not versioning them via SCM won't prevent them from being published on the docs site.