feat(docs): updates to the glossary #14939
Merged
Conversation
This file contains 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
|
I can look into this later today, I think starting to use components for tables and navigation like this will be really helpful 👍 |
|
Here's a comparison of the old vs new (the old one was removed in favor of the MDX component that's shown on the bottom):
|
lannonbr
added
the
type: documentation
marcysutton
commented
Jun 21, 2019
marcysutton
commented
Jun 21, 2019
|
I added two new terms: CSS and Progressive Enhancement. Also added a link to #frontend about How Browsers Work. It's such a great resource! |
gillkyle
reviewed
Jun 21, 2019
| @@ -84,6 +97,10 @@ The process of [building](#build) your website or app and uploading onto a [host | |||
|
|
|||
| The [environment](#environment) when you're developing your code. It's accessed through the [CLI](#cli) using `gatsby develop`, and provides extra error reporting and things to help you debug before building for [production](#production-environment). | |||
|
|
|||
| ### DOM | |||
|
|
|||
| The Document Object Model, commonly referred to as "the DOM", is a standard browser API that connects web pages to scripts or programming languages by representing the structure of an HTML document in memory. Developers commonly interact with the DOM through [HTML](#html) markup (written in [JSX](#jsx) in Gatsby), as well as both [React](https://reactjs.org/docs/react-dom.html) and [vanilla JavaScript](https://developer.mozilla.org/en-US/docs/Web/API/Document_Object_Model/Introduction#DOM_and_JavaScript) code. Another important aspect of utilizing the DOM to its full potential is writing [accessible](#accessibility) HTML markup to expose a page's structure to assistive technology. | |||
There was a problem hiding this comment.
Reading this definition alone makes me want to link to this page for anyone trying to find info to start learning about web dev 🥇 these are awesome!
Co-Authored-By: gillkyle <[email protected]>
Co-Authored-By: gillkyle <[email protected]>
Co-Authored-By: gillkyle <[email protected]>
|
Going to merge this since it's blocking another PR! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
In reviewing #14846 I wanted to add a link to "backend" in the glossary, but I noticed both that term and "frontend" weren't written to be consistent with the Gatsby Style Guide. I added a few terms that I've noticed were missing and updated a few terms, plus added a navigation block to the top (suggested improvements below). Finally, I noticed the Client Data Fetching doc wasn't actually in the sidebar despite a whole PR for that so I added it.
Something I could use help on is writing the navigation block more dynamically so we can give it better semantics. Right now the Markdown looks like this:
The two things I think need to change for that are:
<nav><ul></ul></nav><li>use a border for the separators instead of pipe charactersSeems like a job for MDX. @gillkyle could you help me with that?