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(developer-guide): include developer guide in compodoc generated docs #33

Conversation

christophercr
Copy link
Collaborator

@christophercr christophercr commented Nov 7, 2019

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[X] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

The Developer Guide is not included in the generated docs by compodoc. Ideally, this Dev Guide should not only be reachable via Github but also via the published docs website (when that is available).

What is the new behavior?

  • refactor compodoc configuration in a .compodocrc.json file to make it more readable and flexible in order to include the different MD files under /docs to create the Developer Guide.
  • fix not well-formed links and adapt some urls in the Developer Guide

Does this PR introduce a breaking change?

[ ] Yes
[X] No

@christophercr christophercr added comp: docs enhancement New feature or request labels Nov 7, 2019
@christophercr christophercr added this to the 1.0.0 milestone Nov 7, 2019
@christophercr christophercr force-pushed the feature/compodoc-config-refactoring branch from 0d2015a to a87bdb6 Compare November 7, 2019 11:20
Copy link
Member

@SuperITMan SuperITMan left a comment

Choose a reason for hiding this comment

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

😊

Copy link
Member

@SuperITMan SuperITMan left a comment

Choose a reason for hiding this comment

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

😊

@christophercr christophercr merged commit 2a37d3d into NationalBankBelgium:master Nov 7, 2019
@christophercr christophercr deleted the feature/compodoc-config-refactoring branch November 7, 2019 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
comp: docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants