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

Starting version of website with docs pages and rules #4099

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Nov 7, 2021

PR Checklist

Overview

A trimmed down version of @armano2's beautiful #3147, with the website/ directory moved into packages/ for consistency. Builds off the same branch's Git commit history.

In addition to the tasks already mentioned in #3147, we'll need to follow up on at the very least:

  • Deploying to Netlify
  • Adding back the playground/REPL area
  • Audit language, phrasing, flow, etc. of docs
  • Reworking the rules page, such as improving the h1 and removing previous/next
  • Accessibility/aXe audit
  • Automate calling generate-sponsors regularly, such as the way generate-contributors is on a cron
  • Fix the warn Docs markdown link couldn't be resolved: warnings
  • Investigating moving docs/ files to the packages/website directory (not sure we want to)

I'd additionally like to file followup tasks for:

  • Search (Algolia?)
  • Adding some kind of easter eggs 😉
  • Creating our own theme to stand out
  • Requiring issues use the playground if possible 💪

Unless directed otherwise I'll probably play with GitHub projects to set all that up.

website/package.json Outdated Show resolved Hide resolved
website/package.json Outdated Show resolved Hide resolved
armano2
armano2 previously requested changes Nov 7, 2021
Copy link
Member

@armano2 armano2 left a comment

Choose a reason for hiding this comment

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

website/src/modules and website/src/vendor should be removed

current compile errors has been solved in #4101

website/package.json Outdated Show resolved Hide resolved
Co-authored-by: Armano <armano2@users.noreply.github.com>
website/package.json Outdated Show resolved Hide resolved
@JoshuaKGoldberg

This comment has been minimized.

@JoshuaKGoldberg JoshuaKGoldberg changed the title Website trim Starting version of website with docs pages and rules Nov 7, 2021
@JoshuaKGoldberg JoshuaKGoldberg changed the base branch from master to fix-babel-7_16-tests November 8, 2021 00:02
@codecov
Copy link

codecov bot commented Nov 8, 2021

Codecov Report

Merging #4099 (0f325fc) into fix-babel-7_16-tests (0cf5ae3) will decrease coverage by 0.38%.
The diff coverage is n/a.

@@                   Coverage Diff                    @@
##           fix-babel-7_16-tests    #4099      +/-   ##
========================================================
- Coverage                 93.11%   92.73%   -0.39%     
========================================================
  Files                       174      334     +160     
  Lines                      9619    11494    +1875     
  Branches                   3004     3270     +266     
========================================================
+ Hits                       8957    10659    +1702     
- Misses                      248      362     +114     
- Partials                    414      473      +59     
Flag Coverage Δ
unittest 92.73% <ø> (-0.39%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...perimental-utils/src/ts-eslint-scope/Referencer.ts 100.00% <0.00%> (ø)
packages/scope-manager/src/lib/esnext.bigint.ts 100.00% <0.00%> (ø)
...kages/scope-manager/src/lib/es2017.sharedmemory.ts 100.00% <0.00%> (ø)
packages/scope-manager/src/referencer/index.ts 100.00% <0.00%> (ø)
...ackages/experimental-utils/src/ts-eslint/ESLint.ts 50.00% <0.00%> (ø)
packages/scope-manager/src/lib/es2018.promise.ts 100.00% <0.00%> (ø)
packages/scope-manager/src/lib/es2017.intl.ts 100.00% <0.00%> (ø)
packages/scope-manager/src/lib/es2019.symbol.ts 100.00% <0.00%> (ø)
...-utils/src/ast-utils/eslint-utils/scopeAnalysis.ts 100.00% <0.00%> (ø)
packages/scope-manager/src/lib/esnext.symbol.ts 100.00% <0.00%> (ø)
... and 150 more

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review November 8, 2021 00:40
@JoshuaKGoldberg JoshuaKGoldberg dismissed armano2’s stale review November 8, 2021 00:42

Addressed feedback - would love another review please!

@JamesHenry JamesHenry deleted the branch typescript-eslint:fix-babel-7_16-tests November 8, 2021 14:08
@JamesHenry JamesHenry closed this Nov 8, 2021
@JoshuaKGoldberg JoshuaKGoldberg deleted the website-trim branch November 9, 2021 01:33
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 10, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation update request
3 participants