> I mean completely change the existing documentation page Sorry to belabor the point, but can you describe what you mean by this, with specific points?
I'm also a bit confused by the two seemingly conflicting ideas: > Exactly! Collect everything on a single page but in a clean manner so that person does not have to visit new web pages/click links again and again. Most information would be hidden until the user expands them. I think redirecting is messy and person ends up with multiple tabs open > Avoiding mixing of topics. I mean, for example when the documentation is talking about "interpreting ESLint results" it will only talk about that and provide jump links <https://www.google.com/search?q=jump+links&rlz=1C1CHBF_enIN807IN807&oq=jump+links&aqs=chrome..69i57j0l5.2574j1j7&sourceid=chrome&ie=UTF-8> if necessary to refer other topics > Writing the documentation in points Do you mean writing everything in bullet points? I don't think this is particularly helpful except in the case of lists (summaries of each section in bullet form, might make sense), especially when longer descriptions are necessary. > Brief explanations Do you feel like the current docs are overly verbose? > Easy "copy paste" codes available where required I like this idea a lot! > Colors to make everything more readable Can you be more specific about this? Overall, I'm finding it difficult to evaluate a lot of these points because they lack specifics. Happy to provide more feedback if you can provide more specifics! Thanks, Kai On Wed, May 13, 2020 at 12:21 PM suyash singh <[email protected]> wrote: > >>> 1. Do you mind clarifying what you mean by making a new site? Are you >>> envisioning we create a separate site for the getting started section of >>> the site? >>> >> I mean completely change the existing documentation page > >> >>> 2. Can you expand on the idea of a drop down menu? Where would it be on >>> the site and what would be included? >>> >> Something like the expanding tabs under the "overview" on this site > <https://open.berkeley.edu/guides/site-builders-guide/edit-html-page/expandcollapse-content> > but > much better looking. All the topics > <https://github.com/eslint/eslint/issues/13130#issuecomment-614916040> will > be the "title" of those expanding tabs, upon expansion we get the > details/steps.For example a tab <Installing ESLint>, user expands it and is > able to view the installation guide without having to go to a new page > >> >> >>> >>> 3. Can you clarify what you mean by finding everything on a single page? >>> I think one of the problems with our current documentation is that some >>> pages contain a lot of information and it’s really difficult to find the >>> information you’re looking for. >>> >> Exactly! Collect everything on a single page but in a clean manner so > that person does not have to visit new web pages/click links again and > again. Most information would be hidden until the user expands them. I > think redirecting is messy and person ends up with multiple tabs open > >> >>> 4. For the Getting Started guide, organization and presentation are >>> going to be particularly important. Since this will likely be the first >>> documentation users will look at, we’ll want to make a good impression. I’d >>> love to hear how you think we could achieve this. >>> >> I have some ideas regarding this, > -> Writing the documentation in points > -> Brief explanations > -> Easy "copy paste" codes available where required > -> Colors to make everything more readable > -> Avoiding mixing of topics. I mean, for example when the documentation > is talking about "interpreting ESLint results" it will only talk about that > and provide jump links > <https://www.google.com/search?q=jump+links&rlz=1C1CHBF_enIN807IN807&oq=jump+links&aqs=chrome..69i57j0l5.2574j1j7&sourceid=chrome&ie=UTF-8> > if > necessary to refer other topics > >> -- > You received this message because you are subscribed to the Google Groups > "ESLint" group. > To unsubscribe from this group and stop receiving emails from it, send an > email to [email protected]. > To view this discussion on the web visit > https://groups.google.com/d/msgid/eslint/052a2d62-e4a9-463c-bcac-2ea0d00a3d41%40googlegroups.com > <https://groups.google.com/d/msgid/eslint/052a2d62-e4a9-463c-bcac-2ea0d00a3d41%40googlegroups.com?utm_medium=email&utm_source=footer> > . > -- Kai Cataldo Independent Software Developer & maintainer of ESLint <https://eslint.org/> and Babel <https://babeljs.io/> kaicataldo.com -- You received this message because you are subscribed to the Google Groups "ESLint" group. To unsubscribe from this group and stop receiving emails from it, send an email to [email protected]. To view this discussion on the web visit https://groups.google.com/d/msgid/eslint/CAKfCaPgrm%3DRoZ7AeW%2BgjNLSyOzkP27%3DwfjSfix48ZAh-8%2B-ZGQ%40mail.gmail.com.
