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

Separate the README and the actual documentation #92

Closed
almet opened this issue Jun 29, 2015 · 2 comments
Closed

Separate the README and the actual documentation #92

almet opened this issue Jun 29, 2015 · 2 comments

Comments

@almet
Copy link
Member

almet commented Jun 29, 2015

Currently, the documentation uses the README file and as such displays a link to the documentation, which isn't useful when we're already on the documentation page (because you already know where the documentation is).

Removing the links from the readme (as was attempted previously) also removes them from the github repository, where it's actually valuable. I believe the best way to proceed would be to actually have the readme as a different resource than the actual documentation.

@almet almet mentioned this issue Jun 29, 2015
3 tasks
@almet almet added the question label Jun 29, 2015
@Natim
Copy link
Member

Natim commented Jun 29, 2015

I see this link more as an ID of the official URI of the current resource.

I don't understand why it bothers you that much but if you really want to remove this link the way forward is to remove the inclusion of the readme in the documentation index. Note that we may have duplicates between the README and the home page.

@almet
Copy link
Member Author

almet commented Jun 29, 2015

Let's just remove the inclusion of the readme then. It doesn't bothers me that much, it's just that it's getting in the way of having an easier to follow documentation, that's all.

@leplatrem leplatrem modified the milestone: 1.4.0 Aug 14, 2015
@Natim Natim modified the milestones: 1.4.0, 1.5.0 Sep 9, 2015
@Natim Natim closed this as completed Sep 9, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants