search

decred / politeia

ISC License
110 stars 75 forks source link

Proposal summary field #569

Closed xaur closed 5 years ago

xaur commented 5 years ago

Add a lenght-restricted summary field to the proposal data structure.

This field can be used in messaging (marketing, e.g. tweets) and come directly from the prop author.

From the discussion of proposal summaries in #writers_room:

jy-p: i think a brief summary of the proposals under consideration should be sufficient. maybe we should require a 1-3 sentence summary of each proposal specifically for this purpose, so the author can communicate this directly. versus having someone else add their spin

crypto-rizzo commented 5 years ago

I think this solution can be solved just through the GUI. I wrote another issue here https://github.com/decred/politeiagui/issues/1000

marcopeereboom commented 5 years ago

I don't think the backend should be cooking the data. Any invocator can summarize with the data provided.

xaur commented 5 years ago

Any invocator can summarize with the data provided.

Not fully understood that. Do you mean to put the summary into proposal body?

marcopeereboom commented 5 years ago

The JSON call returns the entire proposal so on the front-end you can generate any summary you'd like. If you want some sort of shorter identifier use a TBD number of characters from the token. These are all front-end features. I will not permit adding API that will live forever that does not solve an actual issue.

xaur commented 5 years ago

The idea is not to generate a summary by a computer from the proposal but to let (and encourage) proposal owner to specify a short human written summary that can be used in UI, notifications, tweets, etc.

It's not about "backend cooking the data".

marcopeereboom commented 5 years ago

GitHib does that and everyone copies the first sentence from the general description instead. This serves no purpose and would alter the backend data to a point that it would need to be versioned and upgraded.

xaur commented 5 years ago

everyone copies the first sentence from the general description instead

That could work too.

It would need to be a convention that authors must be aware of and follow. Perhaps via a hint on the proposal form UI: "First sentence of your proposal text will be used as a short description in various places. Try to fit it in 200 characters.". A live preview could be shown too.

One challenge for authors would be to carefully format the summary within the proposal so that it is correctly extracted by the tools. For example, they would need to insert it after proposal title but before using any headings. DEX RFP proposal adjusted to this format would look like:

RFP: Decred Decentralized Exchange Infrastructure

This proposal describes a new type of cryptocurrency-only decentralized exchange based on open source software that will allow cross-chain trading to occur directly between users, with minimal fees and a simple client-server architecture.

## Abstract

...