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

Add ability to include unique sections on the Development tab #72

Open
blackbaud-johnly opened this issue Jun 26, 2020 · 2 comments
Open

Comments

@blackbaud-johnly
Copy link
Contributor

We probably need the ability to add sections to the Development tab for content that doesn't neatly fit into the sections that JSDoc automatically creates for reference content. As we are converting docs to phase 2, we continue to come across sections in the existing docs that don't neatly fit into the reference sections that docs-tools creates. For example, Accessibility sections at the end of several component topics. And some of the additional guidance sections in the ag-Grid docs. It looks like this may be an issue for data manager as well.

I'm creating this issue after discussing it at SKY UX standup. We agreed that we should discuss this at the next Tuesday docs check-in to discuss the severity of this need and whether we really need this capability and also to assess how much work it would take.

@Blackbaud-SteveBrush
Copy link
Member

We'll create a custom component that will be placed before the code samples but after the API content.
The component would have the following inputs:

  • heading The heading for the content.
  • placement Above or below the API content.

@Blackbaud-KerryCampbell

1649307

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

No branches or pull requests

5 participants