Proposal: Improve project homepage

[misitebao]

The following are just my personal suggestions as a user.

• Moved the examples section of the project home page to the examples directory.
  Because there are too many pictures and the content is too long, it takes a long time to load the project homepage. After the move you can provide a link to the examples directory.
• Move the *.go files in the project root directory to the pkg directory.
  There are too many code files in the root directory, and you need to scroll a long distance to see the README. I believe that most people who visit the project will not view the code on the project home page, but to view the README. Because it is still in the 0 version, you don’t need to consider compatibility, so you can migrate directly; of course, you can also choose to release the 1 version directly to achieve migration.

If the maintainer accepts this proposal, I would like to help with this part of the work.

[MarvinJWendt]

Hi @misitebao, I totally agree with the examples. I can see that this is an issue with slower internet. If you want to work on that, the README is modified in our CI-System (/ci) (it's an awful messy piece of code, but "it works", so I would understand if you don't want to touch it).

For moving the *.go files, I will keep this issue open for discussion. As you are already aware, I wanted to do this with #471, but decided not to, because of the breaking change. Yes, we currently are in v0 to be able to make breaking changes, without releasing a v2, but I still think we should consider that this change will break ~1000 open-source projects and many more private repos. Although it would be an easy fix for the repo maintainers, as a simple replace all in the project would do the job.

I think we should at least wait until the new GitHub design is public, which hides the file tree to a sidebar and puts the README at the top. We have a few breaking changes in the queue, until then we would still have time to evaluate that, as we want to have all breaking changes in one version (v0.13.0)

[MarvinJWendt]

If we move the *.go files, we should probably include a single code block at the top of the README with a bash command to fix the import statements (for a couple of weeks), as a migration guide.

[misitebao]

Hi @MarvinJWendt,

There are mainly two questions here:

1. Update README and examlpes, including the corresponding CI program
2. Migrate .go files in the root directory

For the first question, as you said, it will be more complicated. I think we can do it step by step, first manually update the README, and then update the others, because the README is the main factor affecting the speed of the home page. For examples and ci, it can be improved slowly.

For the second question, migrating .go files is a major change and should be resolved in the next major version. However, because it is still in the 0.x.x stage, compatibility can be ignored as long as users do not actively update dependencies. There will be no problem. But the user's CI system will automatically update dependencies according to the semantic version, so the best way is to release 1.0.0 or 1.0.0-beta.

I know about the new design of GitHub you mentioned, and I have experienced it for a day, but I don’t think it has much to do with the project, because it should be platform-independent. Also I personally think it would be confusing to have the code file with other bits and pieces in the root of the project.

The above is just my personal suggestion and I'd be happy to push it forward.🚀