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.

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

Overviews & copy tweaks in user documentation pages #16473

Closed
1 task done
Tracked by #16365
bpmutter opened this issue Oct 31, 2022 · 2 comments
Closed
1 task done
Tracked by #16365

Overviews & copy tweaks in user documentation pages #16473

bpmutter opened this issue Oct 31, 2022 · 2 comments
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint
Projects
Triage

Comments

@bpmutter
Copy link
Contributor

bpmutter commented Oct 31, 2022 •
edited

ESLint version

v8.x

What problem do you want to solve?

When looking at the usr documentation of ESLint, it can be unclear what the page is about at the start of the page, and why users should care about that page's content.

There are also small copy changes to be fixed throughout these pages.

What do you think is the correct solution?

  • Review all pages in the user documentation section and add overviews at the top of pages explaining what the page covers and why you might use it.
  • For example, on Plugins at the beginning of the page, include an overview of what plugins are.
  • Apply small copy edits throughout these pages.

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response
@bpmutter bpmutter added core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint triage An ESLint team member will look at this issue soon labels Oct 31, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Oct 31, 2022
@bpmutter bpmutter mentioned this issue Oct 31, 2022
Open
45 tasks
@bpmutter
Copy link
Contributor Author

bpmutter commented Nov 5, 2022

notes - https://gist.github.com/bpmutter/9693dc10b7fb6caae144208f38fad9bf

bpmutter added a commit to bpmutter/eslint that referenced this issue Nov 6, 2022
@bpmutter
docs: update configuration file pages
9016ac3 
clean up page copy and add small introductions.

Part of fix for eslint#16473
@bpmutter bpmutter mentioned this issue Nov 6, 2022
Merged
1 task
bpmutter added a commit to bpmutter/eslint that referenced this issue Nov 6, 2022
@bpmutter
docs: add intro and edit ignoring files page
fee8338 
Partial fix of eslint#16473
@bpmutter bpmutter mentioned this issue Nov 6, 2022
Merged
1 task
bpmutter added a commit to bpmutter/eslint that referenced this issue Nov 6, 2022
@bpmutter
docs: language options intro + tweaks
1a7ae22 
Partial fix to eslint#16473
@bpmutter bpmutter mentioned this issue Nov 6, 2022
Merged
1 task
@snitin315 snitin315 added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed triage An ESLint team member will look at this issue soon core Relates to ESLint's core APIs and features labels Nov 7, 2022
This was referenced Nov 13, 2022
Merged
Merged
Merged
Merged
@bpmutter bpmutter changed the title Overviews in user documentation page introductions Overviews & copy tweaks in user documentation pages Nov 13, 2022
snitin315 pushed a commit that referenced this issue Nov 18, 2022
@bpmutter @nzakas @amareshsm
docs: add intro and edit ignoring files page (#16510)
3e66387 
* docs: add intro and edit ignoring files page

Partial fix of #16473

* copy edit

* Apply suggestions from the code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>
snitin315 added a commit that referenced this issue Nov 18, 2022
@bpmutter @snitin315 @amareshsm
docs: Language Options page intro and tweaks (#16511)
34c05a7 
* docs: language options intro + tweaks

Partial fix to #16473

* Apply suggestions from code review

Co-authored-by: Nitin Kumar <snitin315@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>

* Apply suggestions from code review

Co-authored-by: Nitin Kumar <snitin315@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>
@snitin315 snitin315 moved this from Needs Triage to Ready to Implement in Triage Nov 20, 2022
@snitin315 snitin315 moved this from Ready to Implement to Pull Request Opened in Triage Nov 20, 2022
mdjermanovic added a commit that referenced this issue Nov 24, 2022
@bpmutter @harish-sethuraman
@amareshsm @mdjermanovic
docs: Update configuration file pages (#16509)
de12b26 
* docs: update configuration file pages

clean up page copy and add small introductions.

Part of fix for #16473

* copy edits

* Apply suggestions from code review

Co-authored-by: Strek <ssharishkumar@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>

* Apply suggestions from code review

* Apply suggestions from code review

Co-authored-by: Strek <ssharishkumar@gmail.com>

* replace <b> html tag w markdown

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* add nz clarification

Co-authored-by: Strek <ssharishkumar@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@bpmutter
Copy link
Contributor Author

bpmutter commented Dec 3, 2022

Resolved by:

@bpmutter bpmutter closed this as completed Dec 3, 2022
Triage automation moved this from Pull Request Opened to Complete Dec 3, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Jun 2, 2023
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jun 2, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion documentation Relates to ESLint's documentation enhancement This change enhances an existing feature of ESLint
Projects
Triage
Archived in project
Triage
Complete
Milestone
No milestone
Development

No branches or pull requests
2 participants
@snitin315 @bpmutter