feat(docs): adding 'behaviors' section to menu by kolaps33 · Pull Request #119 · microsoft/fluent-ui-react

kolaps33 · 2018-08-21T10:03:26Z

Accessibility description

Changes done in this PR:

adding section 'Behaviors' into the menu under the 'Components' section
in section 'Behaviors' all existing behaviors are listed
inside the particular Behavior all different behaviors for the component are listed
particular description for behavior will be stored in behavior file with tag '@description' - description it will be added in next PR

Please see screenshot with changes:

miroslavstastny

Please make sure this PR contains as few changes as possible. It seems that is contains a lot of changes not directly related to it.

miroslavstastny · 2018-08-21T12:25:15Z

docs/src/examples/components/Menu/Types/MenuExample.shorthand.tsx

-  { key: 'editorials', content: 'Editorials' },
-  { key: 'review', content: 'Reviews' },
-  { key: 'events', content: 'Upcoming Events' },
+  {


Please remove this debug changes

miroslavstastny · 2018-08-21T12:27:28Z

test/specs/components/Image/Image-test.tsx

@@ -0,0 +1,35 @@
+import * as React from 'react'


The changed tests are not part of 'Accessibility documentation', these should be a separate PR.

this actually is a separate PR (https://github.com/stardust-ui/react/pull/74/files) - once that gets merged, the change should disappear from this PR.

codecov · 2018-08-22T15:30:33Z

Codecov Report

Merging #119 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #119   +/-   ##
=======================================
  Coverage   68.02%   68.02%           
=======================================
  Files         101      101           
  Lines        1370     1370           
  Branches      260      269    +9     
=======================================
  Hits          932      932           
  Misses        436      436           
  Partials        2        2

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ca435ed...1f646ed. Read the comment docs.

miroslavstastny · 2018-08-29T15:11:51Z

build/gulp/plugins/gulp-component-menu-behaviors.ts

+      if (!_.isEmpty(blockComments)) {
+        const commentTokens = doctrine.parse(blockComments[0].raw, { unwrap: true }).tags
+        const descriptionToken = commentTokens.find(token => token.title === 'description')
+        description = descriptionToken.description


Check descriptionToken is defined. Now if there is a block comment without @description build crashes.

miroslavstastny · 2018-08-29T15:16:34Z

build/gulp/tasks/docs.ts

 task(
  'build:docs:json',
-  parallel('build:docs:docgen', 'build:docs:component-menu', 'build:docs:example-menu'),
+  parallel(


Watch (yarn start) does not reflect changes if Behavior description changes.

good point :)
I was trying to implement that watch will rebuild either behaviors file, but was not able to find how to do it.
@miroslavstastny or @kuzhelov pleae if you could help me with it?

I added watch for behaviours. Watch currently does not work on Windows (not caused by this PR), I will address that in #172 once this PR is merged.

miroslavstastny · 2018-08-29T15:18:37Z

build/gulp/tasks/docs.ts

 // ----------------------------------------

 const componentsSrc = [`${config.paths.src()}/components/*/[A-Z]*.tsx`]
+const behaviorSrc = [`${config.paths.src()}/lib/accessibility/Behaviors/*/[A-Z]*.ts`]


What about DefaultBehavior.ts?

this is not real behavior which would need documentation, so it doesn't need be included

miroslavstastny · 2018-08-30T12:09:07Z

Also add docs/src/componentMenuBehaviors.json to .gitignore

kuzhelov · 2018-09-04T00:10:21Z

docs/src/components/DocsBehaviorRoot.tsx

+  }
+
+  getNameFromFileName(fileName: string) {
+    const divided = _.startCase(fileName.replace('ts', ''))


it is better to introduce more descriptive name for this variable (like baseName)

kuzhelov · 2018-09-04T00:13:53Z

docs/src/components/Sidebar/Sidebar.tsx


 const pkg = require('../../../../package.json')
 const componentMenu = require('docs/src/componentMenu')
+const behaviorMenuItems = require('docs/src/componentMenuBehaviors')


I would rather suggest to use behaviorMenu as a file name (and behaviorMenu as a variable name):

const behaviorMenu = require('docs/src/behaviorMenu')

This will result in consistent pattern with the line above:

const componentMenu = require('docs/src/componentMenu')

kuzhelov · 2018-09-04T00:14:33Z

Couple of minor comments - please, take a look.

Also, please, consider to review changes that were reported by Screener.

Thank you!

mituron added 14 commits August 9, 2018 15:51

editing,adding behaviours and adding acc. description for components

8ad5ae9

removing divider role as it was not correctly implemented

65003f9

returning back divider file, which deleted by mistake

7669fd8

adding tests

83fca4f

adding test, modify tests, change format of description

0309b1f

another changes in descriptions

96aa2e9

merging with latest master

b19a9b8

draft adding acc behaviours to sidebar menu

db2afcd

first raw version of behaviours in menu

a756006

adding parsing, UI improvement

71420a9

adding link to component

1485c92

another polish, moving comments, adding extract-comment package

21482f1

merging with latest master, fixing names in tests

597541c

removing not used commented code

45bb369

kolaps33 requested review from dvdzkwsk, kuzhelov, levithomason, miroslavstastny and mnajdova as code owners August 21, 2018 10:03

kolaps33 changed the title ~~Feat/356641 acc behaviour section~~ Accessibility documentation - structured Aug 21, 2018

kolaps33 changed the title ~~Accessibility documentation - structured~~ Accessibility documentation - structured based on behavior Aug 21, 2018

kolaps33 changed the title ~~Accessibility documentation - structured based on behavior~~ Accessibility documentation - structured, based on behavior Aug 21, 2018

kuzhelov added the 🚀 ready for review label Aug 21, 2018

miroslavstastny suggested changes Aug 21, 2018

View reviewed changes

adding comments to particular behavior files

e5fb701

adding another doc for particular behaviors

6b13568

kuzhelov added 💥 blocked 🚀 ready for review and removed 🚀 ready for review labels Aug 23, 2018

mituron added 2 commits August 28, 2018 16:23

removing description changes in component, it will be moved to new PR

2437532

Merge branch 'master' into feat/356641-acc-behaviour-section

19eaf6a

kolaps33 changed the title ~~Accessibility documentation - structured, based on behavior~~ Accessibility documentation - adding 'behaviors' section to menu Aug 28, 2018

mituron added 4 commits August 28, 2018 17:07

removing changes in componentDocTag, it will go in next PR

0c5379d

removing unused imports

e19d4b0

changes after review

924cca8

Merge branch 'master' into feat/356641-acc-behaviour-section

aef0b86

miroslavstastny reviewed Aug 29, 2018

View reviewed changes

fix after PR

4f0085d

- add behaviors menu to gulp watch

47b2e29

kolaps33 changed the title ~~Accessibility documentation - adding 'behaviors' section to menu~~ feat(accessibility documentation): adding 'behaviors' section to menu Sep 3, 2018

mituron added 2 commits September 3, 2018 14:12

adding changelog

e488c98

after merge with latest master

9607352

kuzhelov approved these changes Sep 4, 2018

View reviewed changes

kuzhelov reviewed Sep 4, 2018

View reviewed changes

kuzhelov changed the title ~~feat(accessibility documentation): adding 'behaviors' section to menu~~ feat(docs): adding 'behaviors' section to menu Sep 4, 2018

kuzhelov added needs author feedback Author's opinion is asked and removed 🚀 ready for review labels Sep 4, 2018

mituron added 2 commits September 4, 2018 09:30

changes after PR, merging with latest master

047e464

another fixes after json file was renamed

1f646ed

kolaps33 added 🚀 ready for review and removed needs author feedback Author's opinion is asked labels Sep 4, 2018

miroslavstastny approved these changes Sep 4, 2018

View reviewed changes

miroslavstastny added ready for merge and removed 🚀 ready for review labels Sep 4, 2018

kolaps33 merged commit a26e33b into master Sep 4, 2018

levithomason deleted the feat/356641-acc-behaviour-section branch October 29, 2019 22:30

Conversation

kolaps33 commented Aug 21, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Accessibility description

Uh oh!

miroslavstastny left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented Aug 22, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

miroslavstastny commented Aug 30, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kuzhelov commented Sep 4, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

kolaps33 commented Aug 21, 2018 •

edited

Loading

codecov bot commented Aug 22, 2018 •

edited

Loading

kuzhelov commented Sep 4, 2018 •

edited

Loading