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

Footer - Improve the language #369

Closed
Tracked by #348
RobTobias123 opened this issue Feb 6, 2024 · 3 comments
Closed
Tracked by #348

Footer - Improve the language #369

RobTobias123 opened this issue Feb 6, 2024 · 3 comments
Assignees
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed Type: Documentation Improvements or additions to documentation

Comments

@RobTobias123
Copy link
Contributor

RobTobias123 commented Feb 6, 2024

Take a look at the current iteration of the Footer in our Astro docs and attempt to improve the language by making it more friendly and including a link for those who don't have (or possibly don't want) a GitHub account.

@RobTobias123 RobTobias123 self-assigned this Feb 6, 2024
@RobTobias123 RobTobias123 added the Type: Documentation Improvements or additions to documentation label Feb 6, 2024
@RobTobias123 RobTobias123 added this to the Internal tools milestone Feb 6, 2024
@RobTobias123
Copy link
Contributor Author

Currently, we are displaying the following:
Screenshot 2024-02-06 at 15 57 39

The issue here is that all the links in the bullet list go to GitHub. My suggestion is to take the 'Report the content issue' link and change that to a non-GitHub way of reporting an issue - perhaps a link to our Teams channel (although that's not available to the public?) feel free to suggest other ways that may be more suitable.

The language also could be perceived as a little abrupt instead of 'concise' as intended. Perhaps, we need to add a bit more 'fluffiness' and be descriptive, to get people to engage.

Here's my suggestion:
"

Found a problem with the content on this page?

Here are some ways you can help:

Suggest an edit [eg. GitHub direct edit link to page]
If you spot an issue, you can propose changes directly on GitHub. Your input matters!

Report a content issue [Teams channel link?]
If something doesn’t look right, let us know. We appreciate your help in keeping our content accurate and helpful.

View this page on GitHub [GitHub link to page with the File directory LHS view]
See this and every page in the Nucleus Docs on GitHub.

Want to get more involved with Nucleus Docs?
Learn how to contribute and be part of our growing community. 🌟"

The last 'contribute' link would need to go to a page similar to the current docs pages Contribute to Nucleus, Our process etc... (Please add any thoughts to this idea here).

@RobTobias123 RobTobias123 added the Status: Review Needed The issue has a PR attached to it which needs to be reviewed label Feb 6, 2024
@andij andij assigned andij and unassigned RobTobias123 Feb 9, 2024
@andij
Copy link
Contributor

andij commented Feb 9, 2024

@RobTobias123
Copy link
Contributor Author

Reviewed.

@andij andij added Status: Completed Nothing further to be done with this issue. Awaiting to be closed and removed Status: Review Needed The issue has a PR attached to it which needs to be reviewed labels Feb 9, 2024
@andij andij closed this as completed Feb 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Status: Completed Nothing further to be done with this issue. Awaiting to be closed Type: Documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants