[nice-to-have] potentially automated author and date tags or labels on web documentation pages/regions #182
hogjamaus-fyi
started this conversation in
Ideas
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
🙄TL;DR wut-teh-heck?
I did not use paragraph formatting actually, as I found the template nice to structure the ideas somewhat differently than others.
👉 Describe the problem
add author summaries and date information to documentation: <> Some documentation seemed a bit disconnected from other documentation somehow?
👥 Problem evidence & reach
cert and install seemed somewhat disjoint: <> Really just a nice to have I guess, helps future proof I would say if your docs ever slow down or responsibility is moved about?
🥰 Describe the "impact" on users?
might help some more nerdy readers: <> Could give the user a consistency around helping and may be disjointedness between edits and authors, and allow for conformance in their mind?
🏆 How to solve this problem
I guess the team or myself would try a commit based on known practices, I suppose their experience and connects would be superior to mine: <> There could be a modal pop-out beside a last edited date (-time) label
Could be a pre-commit hook or some know good practices per file to generate a template mix-in for each page?
Developing
💯 How do we validate the problem is solved?
say cool under the post and add the pull request or somethin: <> if it is worth your time it is or not, anyways I think it would nice to have, not sure the best practices are for this scenario, that's all
Beta Was this translation helpful? Give feedback.
All reactions