Skip to content

Don't use the project readme when testing the renderer #853

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

Closed
aciccarello opened this issue Sep 3, 2018 · 1 comment · Fixed by #857
Closed

Don't use the project readme when testing the renderer #853

aciccarello opened this issue Sep 3, 2018 · 1 comment · Fixed by #857
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged

Comments

@aciccarello
Copy link
Collaborator

aciccarello commented Sep 3, 2018

The current renderer end-to-end test generates an index.html file based on the project readme. While we want to check that the renderer converts markdown to HTML, it is problematic to use the project readme. Any contributions to improve the readme will fail the CI because they also require updating the specs.

The typedoc application config in the render.ts spec file should be updated to point to a static dummy readme that does not change as frequently as the project readme.

Steps

  • Add dummy readme that has some basic markdown to convert
  • Update application config in src/test/renderer.ts to point to readme
  • Update specs
@aciccarello aciccarello added help wanted Contributions are especially encouraged good first issue Easier issue for first time contributors Priority: 3 labels Sep 3, 2018
@Towerism
Copy link
Contributor

I'll take this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Easier issue for first time contributors help wanted Contributions are especially encouraged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants