buildout.coredev icon indicating copy to clipboard operation
buildout.coredev copied to clipboard
verified publisher icon plone

Improve README

Open ramiroluz opened this issue 1 year ago • 3 comments

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

  • [ ] Convert READM.rst to READM.md
  • [x] Add a link to plone official documentation.
  • [x] Add a link to README-make
  • [ ] Create a new page, README-devcontainer (document steps to run devcontainer and github workspace).
  • [x] Add a link to the new page README-devcontainer

ramiroluz avatar Dec 01 '24 20:12 ramiroluz

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

devcontainer-install-vscode-plugin.webm

ramiroluz avatar Dec 05 '24 21:12 ramiroluz

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.

ramiroluz avatar Dec 05 '24 21:12 ramiroluz

Hi @ramiroluz, I noticed there hasn’t been activity on issue #972 since December. Are you still working on it? If not, I’d be happy to take over. Let me know. Thanks!

jatravi avatar Jan 24 '25 06:01 jatravi