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

[doc / website]: when reading documentation, there is no link to repository #11

Closed
clacote opened this issue May 25, 2018 · 4 comments · Fixed by #12
Closed

[doc / website]: when reading documentation, there is no link to repository #11

clacote opened this issue May 25, 2018 · 4 comments · Fixed by #12
Labels
enhancement New feature or request

Comments

@clacote
Copy link
Member

clacote commented May 25, 2018

When reading the doc (https://ngx-speculoos.ninja-squad.com/documentation/index.html), the last chapter mention filling issues or PRs, but there are no links to repository.

image

@clacote clacote added the enhancement New feature or request label May 25, 2018
@jnizet
Copy link
Member

jnizet commented May 25, 2018

The link is in the navbar, and in the Open Source section. I can add a link to issues, but what would the pull requests link point to?

@clacote
Copy link
Member Author

clacote commented May 25, 2018

There is no navbar when reading the documentation. Pull requests could link to https://github.com/Ninja-Squad/ngx-speculoos/pulls. Or you can have a single link to the repository if you prefer.

Feel free to close this suggestion if you think this is enough.
But I was thinking of sharing a deep link to en entry in the doc (like file:///Users/sryl/workspace/ninja/ngx-speculoos/documentation/classes/TestButton.html for example): the directed user has no way to find he repository besides running a Google search.

@jnizet
Copy link
Member

jnizet commented May 25, 2018

Ah, I see. I read too fast and thought the screenshot was from the landing page.
This is just a copy of the project README on github, so it seemed strange to add a link to github in that file. But yes, since the README is also used there, and on the npm project page, adding a link makes sense.
What about "Please, provide feedback by filing issues, or by submitting pull requests on [the Github project]"?

@clacote
Copy link
Member Author

clacote commented May 25, 2018

Sounds good.
In an ideal work, there would also be a link to the Github source in the sidebar (but no idea if you can customise this with CompoDoc).

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

Successfully merging a pull request may close this issue.

2 participants