edit: move DB "Columns" section after "Tables"#7378
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
1 Ignored Deployment
|
sarah11918
approved these changes
Mar 13, 2024
Member
sarah11918
left a comment
sarah11918
left a comment
There was a problem hiding this comment.
I did have my thought on first reading this, too!
sarah11918
added
improve or update documentation
peng
added a commit
to peng/astro-docs
that referenced
this pull request
Mar 14, 2024
* main: (53 commits) i18n(zh-cn): Update `reference/configuration-reference.mdx` (withastro#7385) i18n(zh-cn): Update strapi.mdx (withastro#7380) edit: mention `astro login` on DB create project instructions (withastro#7377) edit: move DB "Columns" section after "Tables" (withastro#7378) i18n(ru): Update `data-fetching.mdx` translation (withastro#7315) i18n(ru): Update `deploy.mdx` translation (withastro#7313) i18n(ru): Update `cms.mdx `translation (withastro#7306) i18n(ru): Add translations for various pages in the `deploy` dir (withastro#7273) i18n(ru): Add `api-reference.mdx` translation (withastro#7251) i18n(ru): Add and update translations for `astro-response-headers-reassigned.mdx`, `error-reference.mdx` and `locals-not-an-object.mdx` pages (withastro#7286) [i18nIgnore] Fix incorrect list numbering (withastro#7274) i18n(ru): Add translations for various pages in the `cms` dir (withastro#7267) i18n(ru): Update `authentication.mdx` translation (withastro#7255) i18n(ru): Add `apostrophecms.mdx` and `builderio.mdx` translations (withastro#7266) i18n(ru): Update `auto.mdx` translation (withastro#7258) i18n(ru): Update `environment-variables.mdx` translation (withastro#7311) [i18nIgnore] Fix incorrect list numbering in `guides/deploy.mdx` (withastro#7312) i18n(ru): Add `external-links.mdx` translation (withastro#7372) i18n(ru): Update `nav.ts` and `ui.ts` translations (withastro#7318) Update ghost.mdx (withastro#7365) ...
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
2 participants
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 (required)
There are a couple reasons I'd like to move the "columns" section after "tables:"
Order of explanation. It's impossible to describe a column without first describing a table, and this was clear from the preamble. It's also odd to show users all available column types before explaining how a table can be configured in the first place. By moving the column preamble into the "tables" section, and pushing the "columns" snippet below, the user is presented with the most minimal example for configuration before reading the details.
Copy / paste warriors. While watching a user walk through the docs (t3dotgg), they reached the "columns" section of the docs and naturally copied the snippet to build their config. Trouble is, this snippet includes a number of complex column types, while the simpler Tables snippet would make for an easier demo. By presenting the sample Tables config first, users can copy the simplest demo.
Related issues & labels (optional)