docs: When using the "Edit on GitHub" button references to the guides are not obvious

[refack]

• Version: current
• Platform: web
• Subsystem: doc

Perhaps the only thing I could note (if it's of any use in improving the docs' "Edit on GitHub" process) is that I don't believe I was alerted, when submitting the PR, to the fact that a style guide existed for the docs, against which I could check any amendments I was suggesting.

When clicking the button, the user is directed to the edit view in GitHub. There is no reference to the Docs Style Guide, and when submitting the PR the referance to the Contributing Guide is easy to miss.

Ideas for improvement will be most appreciated.

Refs: #23970 (comment)
Refs: #21703

/CC @nodejs/documentation @nodejs/website

[Trott]

Since the idea of that button is to have as little friction as possible for people doing small-but-valid fixes right when they notice them while reading the docs, I'd be OK with just a blanket relaxation on nit requests etc. for these kinds of PRs. We don't get many of these PRs (although I'd love to see more) and as long as the people who usually handle documentation stuff (@nodejs/documentation in general, but @vsemozhetbyt in particular!) don't mind cleaning up the commit message themselves, deleting the occasional trailing space, and fixing a style nit here or there, I'd prefer to keep the friction low for the contributor. Of course, if we're getting a bunch of problematic PRs and it's burdensome to the people handling the PRs, that changes everything...

[Trott]

(All that said, I'm totally open to improving the experience. A link to the Style Guide is probably a good idea, if we can implement in a way that won't cause more problems than it solves. Also: We should clean up the Style Guide....)

[refack]

We should clean up the Style Guide...

Since we now have a single file linter (https://github.com/nodejs/node/blob/master/tools/lint-md.js) if we could just find a way to reference it, that might be very helpfull. IMO it gives very clear output.
Maybe we could "bot" it, have it run on the proposed changes set and give automatic feedback... Something along the lines of nodejs/build#1554...

[Trott]

Since we now have a single file linter (https://github.com/nodejs/node/blob/master/tools/lint-md.js) if we could just find a way to reference it, that might be very helpfull. IMO it gives very clear output.
Maybe we could "bot" it, have it run on the proposed changes set and give automatic feedback... Something along the lines of nodejs/build#1554...

Does the Travis lint job not do the markdown linting already? Or is the idea to add more rules to the markdown linter so that it more strictly lints for style guide issues? We did recently add the 80-character line-length linting, so that's something! :-D

[refack]

Does the Travis lint job not do the markdown linting already?

I meant pushing the changes / fixed to the gui, either as a commit, or as suggestions. Something like auto-correct, get the feedback in near-real-time.
The motivation is tools-over-nits, get the feedback in consumable form, so that humans won't need (get) to.

I my mind's eye it's what GitHub tasks could do.

[github-actions]

There has been no activity on this feature request for 5 months and it is unlikely to be implemented. It will be closed 6 months after the last non-automated comment.

For more information on how the project manages feature requests, please consult the feature request management document.

[github-actions]

There has been no activity on this feature request and it is being closed. If you feel closing this issue is not the right thing to do, please leave a comment.

For more information on how the project manages feature requests, please consult the feature request management document.