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: update title casing for consistency in page and navigation #1462

Merged
merged 1 commit into from
Feb 28, 2019

Conversation

jkmdev
Copy link
Contributor

@jkmdev jkmdev commented Feb 28, 2019

Description

Fixes #1394
Changes how the docusaurus sidebar for fast-dna packages displays their titles via the build/documentation/copy-package-readme.js script; uses the title in the package readme.md files to determine formatting/casing. Also renames one of the package readme files so it is recognized by the script.

I was considering using a json file to store this title information instead and drawing from there. I went with this current method because it would be less work to maintain but it relies on how the readme.md files are formatted (e.g. the package title needs to be the first line with text for this script to work). If there's a preference for the former approach I can switch to that one.

Motivation & context

The titles in the docusaurus sidebar wasn't conforming to the proper style guidelines, this change fixes that.

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.

@codeclimate
Copy link

codeclimate bot commented Feb 28, 2019

Code Climate has analyzed commit c1f6193 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 awentzel merged commit da84287 into microsoft:master Feb 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

update title casing for consistency in page and navigation
3 participants