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

Docs/improvements #1435

Closed
wants to merge 6 commits into
base: master
from

Conversation

Projects
None yet
4 participants
@molant
Member

molant commented Oct 22, 2018

Pull request checklist

Make sure you:

For non-trivial changes, please make sure you also:

  • Added/Updated related documentation.
  • Added/Updated related tests.

Short description of the change(s)

This fixes a bunch of issues related to documentation.

@molant molant requested review from alrra, antross and sarvaje as code owners Oct 22, 2018

@molant

This comment has been minimized.

Member

molant commented Oct 22, 2018

I'm renaming a section in the docs entirely that all the packages point to (the .hintrc one). We also have a problem with the documentation in the site not showing the main page for subsections (and that page is now a main one). I'm going to work on that thing next but still will need to update the links from all the packages. I still haven't decide how to solve that because we need to make sure everything rests accessible. I'll continue the discussion over there so maybe review and wait until that one is merged?

@molant

This comment has been minimized.

Member

molant commented Oct 23, 2018

Once webhintio/webhint.io#549 is merged, the ToC will look like this:

Proposed Current
image image

@molant molant force-pushed the molant:docs/improvements branch from a5f1e42 to a4cd1f4 Oct 23, 2018

@molant

This comment has been minimized.

Member

molant commented Oct 23, 2018

@alrra changed done and force pushed so it's in the right commits.

@antross

Added some links where we edited the same documentation in parallel PRs so we can compare before merging.

@antross

Just a few edits.

Also, do we call out the ability to run against the filesystem somewhere? Not sure it's part of these changes, but I don't recall seeing that anywhere in the docs (all the examples I remember pointed hint at a public URL).

Show resolved Hide resolved packages/hint/docs/user-guide/concepts/parsers.md
Show resolved Hide resolved packages/hint/docs/user-guide/concepts/parsers.md
Show resolved Hide resolved packages/hint/docs/user-guide/concepts/parsers.md
"name": "connectorName"
},
"formatters": ["formatterName"],
"pasers": ["parserName"],

This comment has been minimized.

@antross

antross Oct 23, 2018

Member
Suggested change Beta
"pasers": ["parserName"],
"parsers": ["parserName"],
"name": "connectorName"
},
"formatters": ["formatterName"],
"pasers": ["parserName"],

This comment has been minimized.

@antross

antross Oct 23, 2018

Member
Suggested change Beta
"pasers": ["parserName"],
"parsers": ["parserName"],
@molant

This comment has been minimized.

Member

molant commented Oct 23, 2018

do we call out the ability to run against the filesystem somewhere

Will open an issue for that as I think it needs some thinking and probably more than just a few word (short video will be nice...).

molant added some commits Oct 22, 2018

Docs: Rename top level entries to `summary.md`
This guarantees that top level sections will appear in the table of
content and that they will also be the first item.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: webhintio/webhint.io#520

@molant molant force-pushed the molant:docs/improvements branch from a4cd1f4 to b312ba7 Oct 23, 2018

@molant

This comment has been minimized.

Member

molant commented Oct 23, 2018

@antross changes done.

@alrra alrra closed this in 8ad4516 Oct 24, 2018

@molant molant deleted the molant:docs/improvements branch Oct 31, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment