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

Documentation layout shell #302

Closed
endigo9740 opened this issue Sep 28, 2022 · 4 comments · Fixed by #330
Closed

Documentation layout shell #302

endigo9740 opened this issue Sep 28, 2022 · 4 comments · Fixed by #330
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request ready to test Ready to be tested for quality assurance.
Milestone

Comments

@endigo9740
Copy link
Contributor

endigo9740 commented Sep 28, 2022

This is very similar in concept to our AppShell component, but rather than providing control for our app layout, we create a reusable component template that can be used for controlling the layout and design of our documentation pages. Given these have a lot of repetition!

Loose ideas:

  • Small bits of data are controlled with multiple props or a singular "config" prop (title, desc, imports, source link, etc)
  • We provide table data to the component to generate whole sections, perhaps folded into tabbed areas
  • We insert Usage via a dedicated slot, perhaps the default slot, as this varies wildly doc to doc
  • Perhaps we standardize out example/sandbox preview? Would be great if these were always interactive!
  • We look to dynamically generate a table of contents, perhaps per page, based on headings, data attributes, etc
  • (more ideas to come....)

image

@endigo9740 endigo9740 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 28, 2022
@endigo9740 endigo9740 self-assigned this Sep 29, 2022
@endigo9740 endigo9740 added this to the v1.0 milestone Oct 3, 2022
@endigo9740 endigo9740 pinned this issue Oct 3, 2022
@endigo9740
Copy link
Contributor Author

endigo9740 commented Oct 5, 2022

Plotting out the structure and requirements.

Header

  • Name/Description - slot

Details

  • import: (list of Svelte imports)
  • stylesheets - (tailwind elements; included in X)
  • source: view source code
  • doc: edit this page
  • package: @brainandbones/skeleton (default)
  • depedencies: (ex: highlight.js)

Examples

Standarize Sandbox?

  • Examples/Sandbox - slot

Tabbed Sections

Support parent/child components

  • Usage - default slot
    • Mix of docs + small examples
    • Browser Support?
  • Props - slot/tables
  • Classes - slot/tables
  • Slots - slot/tables
  • A11y/Keyboard - slot/tables/APG

@endigo9740
Copy link
Contributor Author

I've implemented a working draft of new component layout. It allows for a MUCh more sophisticated and dynamic documentation layout and visual presentation. Very please with the initial results.

Screen Shot 2022-10-05 at 4 30 04 PM

Here's the Accordion component documented:

Screen Shot 2022-10-05 at 4 29 38 PM

Showing the Accordion properties tab:

Screen Shot 2022-10-05 at 4 29 48 PM

@endigo9740 endigo9740 linked a pull request Oct 5, 2022 that will close this issue
@endigo9740
Copy link
Contributor Author

This has now been merged into dev branch and is ready for review!

@endigo9740 endigo9740 reopened this Oct 7, 2022
@endigo9740 endigo9740 added the ready to test Ready to be tested for quality assurance. label Oct 7, 2022
@endigo9740
Copy link
Contributor Author

Marking this completed and ready for release.

@endigo9740 endigo9740 unpinned this issue Oct 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request ready to test Ready to be tested for quality assurance.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant