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

docs: update the create-a-store guide #443

Merged
merged 2 commits into from
Mar 10, 2024
Merged

Conversation

nfriedly
Copy link
Member

@nfriedly nfriedly commented Mar 8, 2024

A couple of updates to the creating a store guide:

  • call out prefix and localKeys fields
  • make the sample code block wider

The second part required removing some of the formatting. It honestly looked nicer before, but I think this is more functional, because you don't have to scroll left-and-right as much to read the example code.

I also looked for a way to have the sample code in it's own standalone .ts and .js files, but couldn't figure out a way to do that and automatically import them into the document, and I think having example code in this document is more valuable. Reducing the level of indentation at least helped.

Context: #442 (comment)

Hiding whitespace changes may make reviewing easier: https://github.com/express-rate-limit/express-rate-limit/pull/443/files?diff=split&w=1

* call out prefix and localKeys fields
* make the sample code block wider

The second part required removing some of the formatting. It honestly looked nicer before, but I think this is more functional.

I also looked for a way to have the sample code in it's own standalone .ts and .js files, but couldn't figure out a way to do that and automatically import them into the document, and I think having example code in this document is more valuable. Reducing the level of indentation at least helped.
@nfriedly
Copy link
Member Author

nfriedly commented Mar 8, 2024

Oh, cool, mintlify automatically deployed a staging instance, so you can compare before and after

@nfriedly nfriedly requested a review from gamemaker1 March 8, 2024 16:33
@gamemaker1 gamemaker1 changed the title Docs: update create-a-store guide docs: update the create-a-store guide Mar 10, 2024
@gamemaker1 gamemaker1 added the documentation Related to documentation label Mar 10, 2024
Copy link
Member

@gamemaker1 gamemaker1 left a comment

Choose a reason for hiding this comment

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

This is great, thanks!!

@gamemaker1 gamemaker1 merged commit 2057187 into main Mar 10, 2024
27 checks passed
@gamemaker1 gamemaker1 deleted the rework-create-store-guide branch March 10, 2024 07:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants