[docs][folder-structure] Added typical gatsby specific folder and fil… #8405
Conversation
docs/docs/gatsby-folder-structure.md
Outdated
| |-- /src // Your project source | ||
| |-- /pages // describe pages dir | ||
| |-- /templates // (optional) describe templates dir | ||
| |-- html.js // (optional) to customise .cache/default-html.js |
There was a problem hiding this comment.
Well, actually I'd just remove the comments completely as your describing the items just right under it and hence it's a duplicate, right?
docs/docs/gatsby-folder-structure.md
Outdated
|
|
||
| - **`/.cache`** This folder is created automatiacally by Gatsby. The files inside this folder is not meant for modification. | ||
|
|
||
| - **`/plugins`** To host local plugins that are not published as an `npm` package. More info here - https://next.gatsbyjs.org/docs/plugins/ |
There was a problem hiding this comment.
Missing proper Markdown link format
+
next.gatsbyjs.org is not needed anymore. v2 is merged and therefore gatsbyjs.org is just fine
shannonbux
left a comment
shannonbux
left a comment
There was a problem hiding this comment.
Hi @palerdot this is looking like a good start!
I made one request.
The only other question I have is can you confirm that you have read through the Default Starter READme and pulled any relevant information into your proposed doc? I think you already have, just wanted to double check. https://github.com/gatsbyjs/gatsby-starter-default
docs/docs/gatsby-folder-structure.md
Outdated
|
|
||
| - **`/.cache`** This folder is created automatiacally by Gatsby. The files inside this folder is not meant for modification. | ||
|
|
||
| - **`/plugins`** To host local plugins that are not published as an `npm` package. More info here - https://next.gatsbyjs.org/docs/plugins/ |
There was a problem hiding this comment.
Would you change all the links to the https://www.gatsbyjs.org site? That is now the main site, after we launched v2 and merged all v2 changes to the www site :)
The other change necessary is to create links using this convention Plugin Library so that the hyperlinked text is clear. See the "use clear hyperlinks" section of the Gatsby Style Guide for tips!
|
@shannonbux @LekoArts Will make the suggested changes and update the PR |
|
@LekoArts @shannonbux I have updated the PR with the suggested changes. Also, I have created a new commit instead of squashing into a single commit. Let me know if the changes are ok. |
|
@palerdot this is great! thanks for putting this together! I've polished up the copy a bit for style and organization. Adding new commits is fine -- our default merge strategy is squash-and-merge so they will all get merged into a single commit. I'm going to go ahead and merge this in now. Follow-up steps:
This is great and really excited to get this in! |
gatsbyjs#8405) * [docs][folder-structure] Added typical gatsby specific folder and files for reference * [docs][folder-structure] improvements * Update and rename gatsby-folder-structure.md to gatsby-project-structure.md * Update gatsby-project-structure.md
4 participants
Documented typical Gatsby folder structure based on this issue - #5694