Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

Add techdocs to registry ui #111

Merged
merged 68 commits into from Oct 12, 2018
Merged

Add techdocs to registry ui #111

merged 68 commits into from Oct 12, 2018

Conversation

notlee
Copy link
Contributor

@notlee notlee commented Aug 3, 2018

There's a lot going on here, so maybe a good time to get a preliminary review. :)

Todo

  • Improve test coverage.
  • Replace JSDoc/SassDoc mock data with real component data.
  • Remove or do something useful with codedoc right sidebar? Gabi & me: remove for now
  • Add content to initial codoc view -- the first class, or mixin that matches the component name?
  • Filter demos same as code docs? Gabi & me: not yet
  • Contribute to solve or workaround code parsing issue.
  • Add syntax highlighting for diff and sh.

screen shot 2018-08-03 at 09 38 44

Resolves Financial-Times/ft-origami#574

@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 3, 2018 15:19 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 3, 2018 15:23 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 3, 2018 15:34 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 9, 2018 15:20 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 9, 2018 16:25 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 9, 2018 16:42 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 10, 2018 11:48 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 10, 2018 13:45 Inactive
@rowanmanning rowanmanning temporarily deployed to origami-registry-ui-qa-pr-111 August 10, 2018 15:53 Inactive
@@ -1,2 +1,6 @@
@include oSyntaxHighlightBase;
Copy link
Contributor

@gvonkoss gvonkoss Oct 5, 2018

Choose a reason for hiding this comment

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

oSyntaxHighlightAll() ?

@notlee
Copy link
Contributor Author

notlee commented Oct 8, 2018

Some screenshots:
screen shot 2018-10-08 at 16 56 54
screen shot 2018-10-08 at 16 57 08

When a component has JS but no valid JsDocs exist:
screen shot 2018-10-08 at 17 34 52

@notlee
Copy link
Contributor Author

notlee commented Oct 8, 2018

Constructors with many params do not display them in their title.
screen shot 2018-10-08 at 17 41 09

But those with few do:
screen shot 2018-10-08 at 17 41 57

Copy link
Member

@rowanmanning rowanmanning left a comment

Choose a reason for hiding this comment

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

Spoke in-person, we're going to merge and get onto QA

@notlee notlee merged commit 517d793 into master Oct 12, 2018
@notlee notlee deleted the tech-docs branch October 12, 2018 14:23
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants