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 logo.png from the root of the project to a hidden .docs directory in the root #57

Closed
Braqzen opened this issue Jun 3, 2022 · 2 comments · Fixed by #58
Closed
Assignees
Labels
Documentation Improvements or additions to documentation Good First Issue Good for newcomers Repo Misc General repository upkeep

Comments

@Braqzen
Copy link
Contributor

Braqzen commented Jun 3, 2022

How does this improve a feature?

It removes unnecessary clutter from the perspective of the user.
They do not need to see this file in the root as it has nothing to do with why they would be browsing this repository.
This will make it slightly easier to navigate the repository since there will be less to click / "take in".

Specification

Creates a .docs directory in the root of the repository and places the logo.png there.
An update to the README.md is also required so that the correct path continues to point at the logo.

Additional context

Tuturu.

@Braqzen Braqzen added Documentation Improvements or additions to documentation Good First Issue Good for newcomers Improvement Enhancing a feature that already exists labels Jun 3, 2022
@Braqzen Braqzen self-assigned this Jun 3, 2022
@adlerjohn
Copy link
Contributor

Instead of hiding it, why not just make a docs directory that can be used also for a book later?

@Braqzen Braqzen removed the Improvement Enhancing a feature that already exists label Jun 3, 2022
@Braqzen
Copy link
Contributor Author

Braqzen commented Jun 3, 2022

Instead of hiding it, why not just make a docs directory that can be used also for a book later?

At the moment we do not have anything to put into the docs for the user to see or for us to generate a book with therefore I rather have it remain hidden until there is something for the user to interact with.
That could be a future improvement to the documentation.

@Braqzen Braqzen added the Repo Misc General repository upkeep label Jun 24, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation Good First Issue Good for newcomers Repo Misc General repository upkeep
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants