docs(flatfile): add 'Create a secret key' section with API-key creation GIF#614
Open
caiopizzol wants to merge 1 commit into
Open
docs(flatfile): add 'Create a secret key' section with API-key creation GIF#614caiopizzol wants to merge 1 commit into
caiopizzol wants to merge 1 commit into
Conversation
…on GIF flatfile.mdx previously had no 'Before you get started' section walking users through credential creation. Adds a narrow section mirroring the structure used in other API-key provider guides (monday, instantly). - Uses Flatfile's own terminology (Secret key vs Publishable key). - Step labels intentionally generic; the GIF carries the precise UI. - 0.84 MB compressed GIF at 494x336 (gifsicle -O3 --lossy=300 --colors 64 --scale 0.7), well within the existing api-key GIF size range. References Flatfile's authentication documentation rather than restating it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
flatfile.mdxpreviously had no "Before you get started" section walking a user through credential creation — it jumped straight from supported actions/objects to "Using the connector," leaving readers to figure out where to get a key. This adds a narrowCreate a Flatfile secret keysection mirroring the structure already used inmonday.mdxandinstantly.mdx.Wording chosen carefully:
Asset:
flatfile-api-key.gifcompressed viagifsicle -O3 --lossy=300 --colors 64 --scale 0.7to 0.84 MB at 494×336, which sits inside the existing api-key GIF size range in the repo (1.2–2.6 MB for similar assets).Out of scope: the Supported Actions/Objects section is untouched. The sample-link reference in "Using the connector" was already resolved by amp-labs/samples#132 (now merged); no docs change needed there.
Screenshot