Skip to content

Documentation #1

Description

@priley86

API Documentation

We'd like to choose a tool which generates API docs for our code. To date in Patternfly, we've used tools like jsdoc. What kinds of API docs would you prefer to see used?

Showcase Documentation

We have a few tools being used in Patternfly today for showcasing our components. There is patternfly.org, patternlab (for patternfly-css) demo, and our patternfly-webcomponents site. What kind of showcase site style would we like?

Component / Widget Documentation

Today in Patternfly, we use test pages for sharing our new components. We also build these in Travis under our forks to share in PRs. What kind of test pages would we like to see used?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions