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.

Sign up for GitHub

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

Jump to bottom

Improve README #972

Open
3 of 5 tasks
ramiroluz opened this issue Dec 1, 2024 · 2 comments
Open
3 of 5 tasks

Improve README #972

ramiroluz opened this issue Dec 1, 2024 · 2 comments
Assignees
@ramiroluz
Labels
04 type: enhancement 14 prio: low 33 needs: docs 41 lvl: easy 42 lvl: moderate

Comments

@ramiroluz
Copy link
Member

ramiroluz commented Dec 1, 2024 •
edited
Loading

README needs some attention and we could start with three improvements.

  • Convert READM.rst to READM.md
  • Add a link to plone official documentation.
  • Add a link to README-make
  • Create a new page, README-devcontainer (document steps to run devcontainer and github workspace).
  • Add a link to the new page README-devcontainer
@ramiroluz ramiroluz self-assigned this Dec 3, 2024
ramiroluz added a commit that referenced this issue Dec 4, 2024
@ramiroluz
Improve README. WIP issue #972.
94e3580
ramiroluz added a commit that referenced this issue Dec 4, 2024
@ramiroluz
Converts READMD.rst to README.md. WIP issue #972
076de52
@ramiroluz
Copy link
Member Author

@davisagli what about putting some small videos in the docs?

devcontainer-install-vscode-plugin.webm

@ramiroluz
Copy link
Member Author

This is the WIP https://github.com/plone/buildout.coredev/compare/ramiroluz-devcontainers-972-improve-readme

It is supposed to track your branch to create a PR to yours at the end.

Just in case anyone feels like starting reviewing already.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ramiroluz ramiroluz

Labels
04 type: enhancement 14 prio: low 33 needs: docs 41 lvl: easy 42 lvl: moderate
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@ramiroluz