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

[Documentation] Missing Architecture and Code Path Analysis in Table of contents #16030

Closed
1 task done
snitin315 opened this issue Jun 21, 2022 · 6 comments · Fixed by #16039
Closed
1 task done

[Documentation] Missing Architecture and Code Path Analysis in Table of contents #16030

snitin315 opened this issue Jun 21, 2022 · 6 comments · Fixed by #16039
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 bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects

Comments

@snitin315
Copy link
Contributor

Environment

https://new.eslint.org/docs/latest/

What parser are you using?

Default (Espree)

What did you do?

Screenshot 2022-06-21 at 7 27 59 AM

Screenshot 2022-06-21 at 7 27 43 AM

What did you expect to happen?

To contain all sub-sections as old docs

What actually happened?

The docs actually exist but they are not visible. So the user will not be able to find the docs.

Participation

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

Additional comments

Is this intended?

@snitin315 snitin315 added bug ESLint is working incorrectly repro:needed labels Jun 21, 2022
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Jun 21, 2022
@aladdin-add
Copy link
Member

sounds an oversight.

@mdjermanovic
Copy link
Member

The docs actually exist but they are not visible. So the user will not be able to find the docs.

I think Code Path Analysis is not in the menus/sidebar on both the current and the new site because it's only of interest for working with rules, and there are links to it on the Working with Rules page. This is the same as with the pages for Selectors and ScopeManager.

As for the Architecture page, I don't know. It seems to be the only page that we have in menus on the current site but not on the new site. (along with the missing Formatters page we're working on in #16018).

@nzakas
Copy link
Member

nzakas commented Jun 22, 2022

Architecture should be in sidebar navigation. Code path analysis should not.

@nzakas nzakas added documentation Relates to ESLint's documentation accepted There is consensus among the team that this change meets the criteria for inclusion and removed repro:needed labels Jun 22, 2022
@nzakas nzakas moved this from Needs Triage to Ready to Implement in Triage Jun 22, 2022
@nzakas nzakas added the good first issue Good for people who haven't worked on ESLint before label Jun 22, 2022
@harish-sethuraman
Copy link
Member

I'd like to work on this issue 😄

@snitin315
Copy link
Contributor Author

I'd like to work on this issue 😄

@harish-sethuraman just wait for some time before sending a PR for the author's reply, especially when I am willing to submit a pull request for this issue. is checked. This leads to duplicate efforts.

@harish-sethuraman
Copy link
Member

just wait for some time before sending a PR for the author's reply especially when I am willing to submit a pull request for this issue. is checked.

Sure 👍🏻 acknowledged :)

Triage automation moved this from Ready to Implement to Complete Jun 22, 2022
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Dec 20, 2022
@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 Dec 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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 bug ESLint is working incorrectly documentation Relates to ESLint's documentation good first issue Good for people who haven't worked on ESLint before
Projects
Archived in project
Triage
Complete
Development

Successfully merging a pull request may close this issue.

5 participants