Skip to content

Conversation

@griest024
Copy link
Member

@griest024 griest024 commented Apr 22, 2025

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

[ ] Bugfix
[x] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[ ] Documentation content changes
[ ] Other... Please describe:

What is the current behavior?

Fixes: #3600, fixes #3733

What is the new behavior?

Does this PR introduce a breaking change?

[ ] Yes
[x] No

Other information

@griest024 griest024 requested a review from xelaint April 22, 2025 23:31
@griest024 griest024 requested review from a team as code owners April 22, 2025 23:31
@griest024
Copy link
Member Author

@xelaint I've added a feature that will allow ToCs to be autogenerated from page content, LMK what you think.

We need to add scrolling to the ToC, it will overflow off the page for large docs like docs/api/cart/state/DaffCartFacade

@xelaint
Copy link
Member

xelaint commented Apr 23, 2025

I'm getting these two different errors in console when I visit design pages

ERROR NullInjectorError: R3InjectorError(Standalone[_DaffioDocsDesignComponentContentComponent])[_DaffioDocsApiContentComponent -> _DaffioDocsApiContentComponent -> _DaffioDocsApiContentComponent -> _DaffioDocsApiContentComponent -> _DaffioDocsApiContentComponent -> _DaffioDocsApiContentComponent]: 
  NullInjectorError: No provider for _DaffioDocsApiContentComponent!
core.mjs:6673 ERROR TypeError: Cannot read properties of undefined (reading 'ɵcmp')

@xelaint
Copy link
Member

xelaint commented Apr 23, 2025

Screen Shot 2025-04-23 at 3 31 11 PM

I don't think it's necessary to display each prop in the TOC.

@griest024 griest024 force-pushed the feat/daffio/docs/header-toc branch from 5435e75 to 350a457 Compare June 5, 2025 15:44
@griest024 griest024 requested a review from a team as a code owner June 5, 2025 15:44
@griest024 griest024 force-pushed the feat/daffio/docs/header-toc branch from 350a457 to 2805635 Compare June 5, 2025 15:48
@griest024
Copy link
Member Author

@xelaint so there are a lot of changes here but to summarize:

Copy link
Member

@xelaint xelaint left a comment

Choose a reason for hiding this comment

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

/docs/api/cart-store-credit these main API package pages don't need a TOC.

@griest024 griest024 requested a review from a team as a code owner June 9, 2025 16:01
@griest024
Copy link
Member Author

griest024 commented Jun 9, 2025

/docs/api/cart-store-credit these main API package pages don't need a TOC.

removed. Also, the styles look off for the API package pages on account of the component hierarchy having changed, can you take a look?
image

@xelaint
Copy link
Member

xelaint commented Jun 10, 2025

@griest024 The mobile TOC (On this page sidebar) on some pages don't have data (e.g. /docs/design/typography)

@griest024
Copy link
Member Author

@griest024 The mobile TOC (On this page sidebar) on some pages don't have data (e.g. /docs/design/typography)

fixed

@griest024 griest024 requested a review from xelaint June 16, 2025 19:53
@griest024 griest024 merged commit 4602e2a into graycoreio:develop Jun 17, 2025
9 checks passed
@gray-bot gray-bot mentioned this pull request Jun 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API functions are missing argument documentation [FEAT] Add Table of Contents to API docs

2 participants