search

liquidvotingio / decidim-module-liquidvoting

GNU Affero General Public License v3.0
4 stars 0 forks source link

Document our module approach in the README #34

Open oliverbarnes opened 3 years ago

oliverbarnes commented 3 years ago

How we change proposal voting, what decidim proposal functionality is lost ...

(Issue proposed by @davefrey, extracted from #25)

davefrey commented 3 years ago

Audience:

  1. product people shopping Decidim modules
  2. developers who need details to integrate

Intro a few phrases to generally describe functionally what we're doing Integration details, enough to get this integrated.

Call out status of specs

oliverbarnes commented 3 years ago

We should have screenshots like the ones on https://github.com/liquidvotingio/decidim-module-liquidvoting/discussions/54

jinjagit commented 3 years ago

We can also use the GitHub wiki on the module repo.

oliverbarnes commented 3 years ago

The problem with the wiki is no versioning and PRs :/

davefrey commented 3 years ago

Definitely screenshots! They'll change with Endorsements but we'll update README of course.

Anyone have thoughts on the two READMEs, the other being liquid-decidim-demo? Maybe we just duplicate anything relevant (like UI screenshots) in both.

I was thinking about wiki too, though another advantage of README is it's inline, no click out to see the stuff, it's right here.

oliverbarnes commented 3 years ago

I think the module is the important thing to document. The demo repo is just a vehicle for it

davefrey commented 3 years ago

Followup to #68. See also liquidvotingio/liquid-decidim-demo#16 README updates