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

chore(docs): update TS doc #34757

Merged
merged 17 commits into from
Feb 10, 2022
Merged

chore(docs): update TS doc #34757

merged 17 commits into from
Feb 10, 2022

Conversation

marvinjude
Copy link
Contributor

@marvinjude marvinjude commented Feb 8, 2022

Description

Update TS documentation Adding the following;

  • Section about tsconfig.json,Explanation on whytsconfig.json it is used/needed
  • How to use /** @type {import('gatsby).GatsbyConfig} */ and other type hints in JS files
  • How to get started with a TS project in gatsby: Use npm init gatsby and use TS selection
  • Migration Guide
  • Mention vanilla-extract as recommended styling solution
  • How to use/setup types in common files like gatsby-config.ts, gatsby-node.ts and src/pages with page props, getServerData, config

Documentation

Update TS Documentation

[sc-44615]

@gatsbot gatsbot bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Feb 8, 2022
@marvinjude marvinjude changed the title chore(docs)update TS doc chore(docs): update TS doc Feb 8, 2022
@marvinjude marvinjude marked this pull request as draft February 8, 2022 13:19
@marvinjude marvinjude added type: documentation An issue or pull request for improving or updating Gatsby's documentation and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Feb 8, 2022
@marvinjude marvinjude marked this pull request as ready for review February 8, 2022 16:38
@marvinjude marvinjude marked this pull request as draft February 8, 2022 16:38
@marvinjude marvinjude marked this pull request as ready for review February 9, 2022 08:05
@marvinjude marvinjude changed the base branch from master to feat/ts-aot February 9, 2022 08:19
@marvinjude marvinjude requested a review from LekoArts February 9, 2022 09:33
Copy link
Contributor

@LekoArts LekoArts left a comment

Choose a reason for hiding this comment

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

Good start so far! Thanks!

@marvinjude marvinjude force-pushed the juag/update-ts-gatsby-doc branch from 690d264 to 5e767ba Compare February 10, 2022 09:40
@marvinjude marvinjude requested a review from LekoArts February 10, 2022 09:40
@LekoArts LekoArts merged commit db05fc8 into feat/ts-aot Feb 10, 2022
@LekoArts LekoArts deleted the juag/update-ts-gatsby-doc branch February 10, 2022 14:01
gatsbybot pushed a commit that referenced this pull request Feb 28, 2022
* get simplest gatsby-config.ts working

* make gatsby-node work

* use program.directory for default-site-plugin for browser/ssr

* chore(docs): update TS doc (#34757)

Co-authored-by: LekoArts <[email protected]>

* feat(gatsby-parcel-config): create parcel config package (#34779)

Co-authored-by: Lennart <[email protected]>

* refactor(core): Polish ahead of time ts implementation (#34773)

Co-authored-by: LekoArts <[email protected]>

* tmp

* update parcel deps version

* update snapshot

* merge master

* feat(core): TS compilation of local plugin gatsby files (#34827)

Co-authored-by: LekoArts <[email protected]>

* Update scaling-issues.md

* Restore build.js

* Restore develop.js

* Restore repl.js

* set flag to always true

* chore(docs): update main tutorial to incorporate TS Updates to create-gatsby (#34890)

Co-authored-by: Lennart <[email protected]>

* chore(gatsby): compile only TS files (#34892)

* use require resolve for defaultConfig

* update doc to add limitations and migration guides

* add structured error logging

* fix cache reslience setup (#34915)

* bump @parcel/source-map in monorepo lock

* adjust tests so cache dirs are cleared only before compilations to workaround EBUSY problems on Windows

* address review comments

* docs: specify gatsby versions supporting particular TS features (#34945)

Co-authored-by: Lennart <[email protected]>

Co-authored-by: Jude Agboola <[email protected]>
Co-authored-by: Ty Hopp <[email protected]>
Co-authored-by: Michal Piechowiak <[email protected]>
Co-authored-by: gatsbybot <[email protected]>
@LekoArts LekoArts added this to the TypeScript Improvements milestone Apr 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation An issue or pull request for improving or updating Gatsby's documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants