Skip to content

Starting version of website with docs pages and rules #4099

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 99 commits into from
Closed

Starting version of website with docs pages and rules #4099

wants to merge 99 commits into from

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Nov 7, 2021 •
edited
Loading

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.

armano2 added 30 commits March 1, 2021 03:16
@armano2
docs: generate simple documentation page
e7e80a2
@armano2
chore: add netlify config
bacfc85
@armano2
fix: update netlify config
e4e3a18
@armano2
fix: remove netlify.toml
17f3ef4
@armano2
fix: add sponsors to start page and update page
9bb88e5
@armano2
fix: correct few minor issues
d80ce4a
@armano2
docs: style improvements on homepage
21a47b0
@armano2
docs: add missing dark mode logo
b0c94cc
@armano2
docs: use svg files for github icon
6102904
@armano2
docs: update homepage and fix hero styles
ba2f030
@armano2
docs: add note about eslint core rules
695744d
@armano2
docs: fix styles for dark theme
b89d9ff
@armano2
docs: add tslint migration guide
84c88b1
@armano2
docs: update docs
160d08d
@armano2
docs: update links
05aa9b2
@armano2
docs: add dynamic github url for testing
c335534
@armano2
docs: wip editor
bdf68dd
@armano2
docs: create basic repl
2772d85
@armano2
fix: add missing package
68f35db
@armano2
fix: add missing typescript
ad76d50
@armano2
fix: correct build for ssr
242e431
@armano2
fix: correct build for ssr and loading all rules
fbcfc41
@armano2
fix: add support for quickfix
75fc69d
@armano2
fix: refactor update markers
567285d
@armano2
fix: setup workspaces and migrate code to typescript
35c7c3b
@armano2
fix: correct build when in monorepo
241dd18
@armano2
fix: reduce number of files that has to be loaded
55fad3d
@armano2
fix: yarn lock after depencency update
cbe134e
@armano2
Merge branch 'fix/yarn-lock'
718de5e 
Conflicts:
	yarn.lock
@armano2
Merge remote-tracking branch 'origin/master' into docs-page
af58a83
armano2
armano2 reviewed Nov 7, 2021
View reviewed changes
armano2
armano2 reviewed Nov 7, 2021
View reviewed changes
armano2
armano2 previously requested changes Nov 7, 2021
View reviewed changes
Copy link
Collaborator

@armano2 armano2 left a comment •
edited
Loading

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

@JoshuaKGoldberg @armano2
Apply suggestions from code review
c84ddbb 
Co-authored-by: Armano <armano2@users.noreply.github.com>
armano2
armano2 reviewed Nov 7, 2021
View reviewed changes
@JoshuaKGoldberg

This comment has been minimized.

Sign in to view
@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 •
edited
Loading

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.
Reviewers

@armano2 armano2 Awaiting requested review from armano2

@bradzacher bradzacher Awaiting requested review from bradzacher

@JamesHenry JamesHenry Awaiting requested review from JamesHenry

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation update request
3 participants
@JoshuaKGoldberg @armano2 @JamesHenry