Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

Some suggestions #21

Open
lervag opened this issue Oct 12, 2021 · 0 comments
Open

Some suggestions #21

lervag opened this issue Oct 12, 2021 · 0 comments

Comments

@lervag
Copy link

lervag commented Oct 12, 2021

I have a couple of "random" suggestions that I think may help improve this project:

  • Remove the figures/media from the repo. Instead, add them either via a secondary repo, an issue thread, or with the github editor. This way, the media is not added to the git repo itself, which makes the repo smaller and more "hygienic".
  • Add a section to your README (and possible docs, later) where you list related projects. It is also nice if such a list explains the main advantage/differencee between yabs and the other project.
  • When the README starts to get long, it is nice to have a table of contents at the top. There's a tool called doctoc hat is useful for automatically generating such tables.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant