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

update title casing for consistency in page and navigation #1394

Closed
awentzel opened this Issue Feb 16, 2019 · 1 comment

Comments

Projects
None yet
1 participant
@awentzel
Copy link
Member

awentzel commented Feb 16, 2019

What feature are you requesting?

  1. The documentation site left navigation should match the existing title of each package readme.
  2. The casing for the left navigation menu for packages should match the casing from the source readme.md file.

What would be the benefit of adding this feature?
Consistency and when we market our products we tend to start with FAST Animation and FAST Layouts so we'll now be giving each package a proper name like these two examples and that will also align with our writing standards.

What solution would be ideal for you?
The original readme source located in ./packages/[name]/README.md has the correct casing now. What should happen when generating the left navigation and documentation is that each readme.md file will be read in, the first "# some title" will be extracted without the "# FAST " and that will be used to generate the name shown on the webpage in the left navigation. The URL will remain the same with all lowercase letters and hyphen delimited words. This way we also are not translating to any special casing, just using as is from the H1 title of the readme.

  1. npmjs.org upon publishing will retain the complete title
  2. FAST documentation site will not include "FAST" to eliminate redundancy
  3. When marketing our products we will refer to them as "FAST Layout", "FAST Components" etc, for example.

What alternatives have you considered?
n/a

Is there any additional context for your request?
This has been discussed an approved @Falkicon on 2/16.

Attach screenshots or images add detail to your request:

@awentzel

This comment has been minimized.

Copy link
Member Author

awentzel commented Feb 26, 2019

I believe @jkmdev is working on this task, but, I can't assign so leaving it under my name.

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.