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

End-user guide/documentation #29

Open
TheCrowbill opened this issue Oct 2, 2022 · 3 comments
Open

End-user guide/documentation #29

TheCrowbill opened this issue Oct 2, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@TheCrowbill
Copy link
Member

I'm inclined to think that this project could use some documentation written with the end-user as its target audience. It would be appropriate to have such a document available on the website as a first resource to which we could point new users or those with operational questions.

To that end, I have started laying the groundwork for such a document. I would to create this collaboratively with any who would wish to contribute so I will be putting it all together in a github repo. My current questions include:

  • What would be the preferred method for creating this? Should I open a new repo, add docs to my fork of this repo and PR, or some other method?
  • What would be the preferred final distribution? ie. a wiki on this repo, a file in the docs folder, a standalone document, etc.

Any input appreciated.

@IstoraMandiri
Copy link
Collaborator

IstoraMandiri commented Oct 3, 2022

Thanks @TheCrowbill , this is on our radar but is intentionally on hold until we work out all kinks of this current system and get some rules sorted. The current codebase is still experimental and not quite yet ready for prime time, but should be getting there once I have implemented a number of improvements this week.

Basically, it would be a same to spend tie creating docs for a system that may change depending on features that don't exist yet, e.g. twitter-together/action#208, which we are still debating how to implement.

Related #26

@IstoraMandiri IstoraMandiri transferred this issue from ethereumclassic/tweets-etc_network Oct 13, 2022
@IstoraMandiri IstoraMandiri transferred this issue from ethereumclassic/tweets-eth_classic Oct 13, 2022
@IstoraMandiri IstoraMandiri transferred this issue from ethereumclassic/tweets-etc_network Oct 13, 2022
@IstoraMandiri
Copy link
Collaborator

From Discord

SETH-MCCORMACK
Just a few observations on the twitter together,
I think it’s great and a more inclusive way to share information, however 99% of the community are not developers and don’t use GitHub.
If we want community engagement then the process needs simplified so we’re not excluding members who don’t know how to create pull requests and such.
Also expecting community members to sign up to another platform just to share some information they’d like to see tweeted on twitter is not realistic IMO, it will just end up an echo chamber of the same voices.
This is just my opinion and I absolutely could be wrong.🤷‍♂️

@ghost
Copy link

ghost commented Oct 15, 2022

See #28

@TheCrowbill TheCrowbill added the documentation Improvements or additions to documentation label Oct 23, 2022
@TheCrowbill TheCrowbill self-assigned this Oct 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants