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

chore: add script for typedoc docusaurus integration #1481

Merged
merged 1 commit into from Mar 7, 2019

Conversation

Projects
None yet
4 participants
@jkmdev
Copy link
Contributor

jkmdev commented Mar 2, 2019

Description

Implements #1382
Creates a script that copies package readme.md files into docs/en/packages. Then uses typedoc to generate Typedoc API documentation that are also added to docs/en/packages. Converts these api files into markdown using the markdown theme from typedoc-plugin-markdown. Also contains a dry-run version for the script.

To run the dry run:

Run npm run docs:build:dry-run in root

To run the regular process:

Run npm install to install the new typedoc and typedoc-plugin-markdown packages
Run npm run docs:build:api in root
cd website
Run npm run start
Navigate to the relevant package readme pages, scroll to the bottom, there should be a link to the related typeoc api doc there

When npm run build is run in the website folder these api docs will be in the ./website/build/fast-dna/docs/en/packages folder.

Motivation & context

This script automates the documentation generation process so that ./website/build/fast-dna contains the entire set of documentation.

Issue type checklist

  • Chore: A change that does not impact distributed packages.
  • Bug fix: A change that fixes an issue, link to the issue above.
  • New feature: A change that adds functionality.

Is this a breaking change?

  • This change causes current functionality to break.

Process & policy checklist

  • I have added tests for my changes.
  • I have tested my changes.
  • I have updated the project documentation to reflect my changes.
  • I have read the CONTRIBUTING documentation and followed the standards for this project.

@jkmdev jkmdev force-pushed the jkmdev:issue-1382 branch from a5c741c to 60d4a0c Mar 2, 2019

@awentzel awentzel changed the title chore: create script for typedoc docusaurus integration chore: add script for typedoc docusaurus integration Mar 2, 2019

Show resolved Hide resolved package.json Outdated
@awentzel
Copy link
Member

awentzel left a comment

Should we update our markdown documentation for a brief summary of how our documentation building process works? do you think this would be useful for other contributors?

@jkmdev jkmdev force-pushed the jkmdev:issue-1382 branch from 60d4a0c to 5899678 Mar 5, 2019

@jkmdev jkmdev requested review from Falkicon and nalogiudice as code owners Mar 5, 2019

@jkmdev jkmdev force-pushed the jkmdev:issue-1382 branch from 5899678 to 41ed591 Mar 5, 2019

Show resolved Hide resolved package.json
chore: create script for typedoc docusaurus integration
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>

@jkmdev jkmdev force-pushed the jkmdev:issue-1382 branch from 41ed591 to 54b5427 Mar 7, 2019

@codeclimate

This comment has been minimized.

Copy link

codeclimate bot commented Mar 7, 2019

Code Climate has analyzed commit 54b5427 and detected 0 issues on this pull request.

The test coverage on the diff in this pull request is 100.0% (50% is the threshold).

This pull request will bring the total coverage in the repository to 88.5% (0.0% change).

View more on Code Climate.

@awentzel

This comment has been minimized.

Copy link
Member

awentzel commented Mar 7, 2019

Talked with @chrisdholt he's ok with these changes so I'm squash/merging.

@awentzel awentzel merged commit db10611 into Microsoft:master Mar 7, 2019

6 checks passed

ci/circleci: build_dependencies Your tests passed on CircleCI!
Details
ci/circleci: test_coverage Your tests passed on CircleCI!
Details
codeclimate All good!
Details
codeclimate/diff-coverage 100% (50% threshold)
Details
codeclimate/total-coverage 88% (0.0% change)
Details
license/cla All CLA requirements met.
Details

nalogiudice added a commit that referenced this pull request Mar 8, 2019

chore: create script for typedoc docusaurus integration (#1481)
Co-authored-by: Aaron Wentzel <16669785+awentzel@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.