question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Generated compodoc documentation no longer working - is it still needed?

See original GitHub issue

Actual Behavior

The generated compodoc is no longer providing the expected documentation for the projects artifacts (components, routing, modules, etc.).

image

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:closed
  • Created 3 years ago
  • Reactions:5
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
jometznercommented, Mar 25, 2021

The current status of our documentation can be found here: https://pwa-gh-review-reports.azurewebsites.net/docs/compodoc/index.html

0reactions
shaukecommented, Apr 19, 2021

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. 😉

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found