Generated compodoc documentation no longer working - is it still needed?
See original GitHub issueActual Behavior
The generated compodoc is no longer providing the expected documentation for the projects artifacts (components, routing, modules, etc.).
Only the projects Markdown documentation is included for some files.
To generate and test the compodoc documentation run
npm run compodoc:serve
Discussion
We are currently trying to decide whether we should invest time into fixing the compodoc integration or if we should just remove it from this project if nobody is/was using it. The non existing feedback regarding this broken functionality since several releases suggests that nobody is missing this documentation. 😉
Voting 👍 = Keep compodoc and fix it 👎 = Remove compodoc 😕 = I don’t care
Issue Analytics
- State:
- Created 3 years ago
- Reactions:5
- Comments:5 (2 by maintainers)
Top Results From Across the Web
Usage - Compodoc
Documentation is generated in default output folder, then run your HTTP server in that folder. compodoc -p tsconfig.doc.json. Render documentation while ...
Read more >When i am using compodoc tool to generate documentation ...
You must be having files Array in tsconfig-app.json. Move content of that files array into includes array. if that array is empty just ......
Read more >[BUG] : wont serve or open generated documentation #45
I have tested multiple configurations on multiple machines and I can not seem to get the project to serve the documentation.
Read more >compodoc - npm Package Health Analysis - Snyk
Open-source and on npm - Use it directly in your project using npm and one script, that's it ! A local tool -...
Read more >Angular Docs with CompoDoc - Codebots
We make use of a documentation tool called CompoDoc to generate all the documentation required for our Angular applications.
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
The current status of our documentation can be found here: https://pwa-gh-review-reports.azurewebsites.net/docs/compodoc/index.html
No we have currently no idea why it is no longer working. We have not analyzed this any further yet. We wanted to know if it is even worth to investigate or if nobody is interested in this documentation anyways. If there would be enough interest in a working compodoc documentation we would start to search for the problem. 😉