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

move confusing "source" link out of README #1187

Open
skierpage opened this issue Jun 30, 2024 · 1 comment
Open

move confusing "source" link out of README #1187

skierpage opened this issue Jun 30, 2024 · 1 comment

Comments

@skierpage
Copy link

(Hi, new user, project looks great!) I was confused by this line in the README:

User documentation and source

I expected "source" to link to some source browser for Cobalt, not the source of its User docs web site. I would up looking for the Rust code implementing Cobalt's _layouts in the code of Cobalt's web site 😕 🙂 .

One could change the line to verbose

but the better fix would be to put the link to the source code for Cobalt's user docs web site on that web site, e.g. in its footer. I could file an issue there, but already this is a lot of verbiage for a minor tweak. I'm happy to make the doc PRs if you agree.

@epage
Copy link
Member

epage commented Jul 9, 2024

Thanks for the feedback. I've at least made the first edit in 2683198

As for the website, I feel like I see two trends2683198ceee45ca87c41aec77a7221d90f0281e

  • A link to github that is a link to the project source which we have with the "Contribute" link
  • A "fork me" link to the website source The standard banner I see would be a bit much. Might be ok to have something more innocuous in the footer. Willing to see a PR porposing an idea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants