Skip to content

docs: add import statements to doc pages #162

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

Conversation

michael-small
Copy link
Contributor

Issue: docs: add import to doc pages #155

#155

@michael-small
Copy link
Contributor Author

@rainerhahnekamp I added imports to the big functions on the sidebar. However, there is helper functions for some things, such as

import { renameDevtoolsName } from '@angular-architects/ngrx-toolkit';

or

import { createReducer } from '@angular-architects/ngrx-toolkit';

among some other functions.

I assume each should have its import listed somewhere on the pages too? I'm thinking either

  1. In the example blocks, or
  2. Under its own header just like the whole pages have their own block at the top

Thoughts?

Once you make a call on that I'll be ready to get this out as a ready PR

@rainerhahnekamp
Copy link
Collaborator

Can we add it to both or would that be too much?

@msmallest
Copy link

That should be good

@michael-small
Copy link
Contributor Author

I went back across everything all the pages and added imports to everything including

  • Top of the page for the main functions
  • Top of the subsections for helper functions
  • All code blocks using any toolkit function, even if the function isn't the main example (withUndoRedo in withDataService examples etc)

I also accidentally managed to add imports for withReset even though that is the other PR, but that PR still adds it to the sidenav so that PR is still relevant.

@michael-small michael-small marked this pull request as ready for review March 19, 2025 02:34
Copy link
Collaborator

@rainerhahnekamp rainerhahnekamp left a comment

Choose a reason for hiding this comment

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

Thanks a lot @michael-small

@rainerhahnekamp rainerhahnekamp merged commit 8ce9a1a into angular-architects:main Mar 19, 2025
1 check passed
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.

3 participants