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

Suggestion: add a gentle, front-and-center, intro to this project's scope #108

Closed
sesam opened this issue Oct 3, 2019 · 4 comments
Closed

Comments

@sesam
Copy link

sesam commented Oct 3, 2019

To capture first-time visitors, would be benefitted by some infographic or light reading. Maybe most of this project's users are happy with long texts :) as I guess it goes with the domain, I think you could get some Hacktoberfest help from education- and design-skilled people by adding some tasks about generating new explanatory/educational content.

So please see this issue as an encouragement to add some issues :) and I can help generate more ideas on this topic in this thread, or close if you don't need this kind of efforts at this time :). Hope this helps!

Context:
As a person with interests in { formal languages | crypto-based contracts | helping to bring things mainstream :) }, when taking a first look at Accord, it feels like a complex and compact collection of parts that might even be sub-projects, and to get a hang of what it all contains, a lot of clicking and guessing how things fit together is needed.

@jeromesimeon
Copy link
Member

@sesam Isn't the main Web site for the Accord Project addressing your request? https://www.accordproject.org

@irmerk
Copy link
Member

irmerk commented Oct 3, 2019

Absolutely I think this helps. We are taking the v0.20 release as a great opportunity to step back and think about how to structure our documentation in different ways for different audiences, because this isn't really something like redux, for example, where everyone using it is likely a developer.

I think #111 is going to be one of the main issue tracking this. I'd absolutely love more input and issues raised by you and others, I think we could certainly use help in this regard.

@jeromesimeon
Copy link
Member

jeromesimeon commented Oct 3, 2019

I would also be interested to know how we could improve the very first page in the technical documentation:
https://docs.accordproject.org/docs/accordproject.html

@jeromesimeon
Copy link
Member

@irmerk @peterhunn @4katie I think this issue has been addressed by the latest material / introduction Section? Can we close?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants