Skip to content

Update The Important Files Doc To Match Current Codebase - #7848

Closed
JamieB-gu wants to merge 1 commit into
mainfrom
update-important-files-doc
Closed

JamieB-gu wants to merge 1 commit into
mainfrom
update-important-files-doc

Conversation

@JamieB-gu

@JamieB-gu JamieB-gu commented Jun 2, 2023 •

Copy link
Copy Markdown
Contributor

Why?

The codebase has changed since much of this was written. This updates or removes each of the descriptions to reflect the current codebase.

Alternatively we could delete it altogether, as it may be likely to become outdated again as the codebase changes: #7849.

Changes

Some descriptions have been updated, others deleted:

  • content.d.ts became content.ts in Refactor content types #6553, and its functionality has changed over time
  • index.d.ts has different types, and islands have changed
  • window-guardian.ts has different functionality
  • ArticleRenderer.tsx has different functionality
  • App.tsx no longer exists since 👋 App.tsx #4262

Some descriptions have been updated, others deleted:

- `content.d.ts` became `content.ts` in #6553, and its functionality has changed over time
- `index.d.ts` has different types, and islands have changed
- `window-guardian.ts` has different functionality
- `ArticleRenderer.tsx` has different functionality
- `App.tsx` no longer exists since #4262
@JamieB-gu
JamieB-gu requested review from mxdvl and shtukas June 2, 2023 16:57
@JamieB-gu
JamieB-gu requested a review from a team as a code owner June 2, 2023 16:57

@mxdvl mxdvl left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Good catch!

@DanielCliftonGuardian DanielCliftonGuardian left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

👍

@JamieB-gu

Copy link
Copy Markdown
Contributor Author

Thanks both! Closing in favour of #7849.

@JamieB-gu JamieB-gu closed this Jun 5, 2023
@JamieB-gu
JamieB-gu deleted the update-important-files-doc branch June 5, 2023 13:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants