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

Extend the README #368

Open
deemp opened this issue May 23, 2024 · 3 comments
Open

Extend the README #368

deemp opened this issue May 23, 2024 · 3 comments
Assignees
Labels
priority 4 (readme) Related to README.md (site) Related to the site

Comments

@deemp
Copy link
Member

deemp commented May 23, 2024

@yegor256 suggested to extend the README (link) with:

  • A short overview of the project
  • A quick start
@deemp deemp added priority 4 (site) Related to the site (readme) Related to README.md labels May 23, 2024
@deemp deemp self-assigned this May 23, 2024
@yegor256
Copy link
Member

@deemp please, don't forget to remove this information from the statically generated site, to avoid duplication

@deemp
Copy link
Member Author

deemp commented May 23, 2024

@yegor256, good point. I'm not sure we should avoid duplication here. Some people may prefer to read the site instead of the README. Hence, they may want to read the project overview and the quick start on the site.

I believe we can share some sections between README and the site. mdbook and mdsh (tools that we use) allow inlining files.

@yegor256
Copy link
Member

yegor256 commented May 23, 2024

@deemp sure, rendering it in both places is fine, as long as you don't duplicate the content inside the repo

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority 4 (readme) Related to README.md (site) Related to the site
Projects
None yet
Development

No branches or pull requests

2 participants