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

Consolidate and upgrade DAO* documentation #58

Closed
3 tasks done
thelastjosh opened this issue Apr 6, 2023 · 21 comments
Closed
3 tasks done

Consolidate and upgrade DAO* documentation #58

thelastjosh opened this issue Apr 6, 2023 · 21 comments
Assignees
Labels
documentation Improvements or additions to documentation help wanted Extra attention is needed priority: high High priority

Comments

@thelastjosh
Copy link
Member

thelastjosh commented Apr 6, 2023

This issue consolidates several tasks for documentation.

Stuff we need to add

  1. Add information from our Aave proposal, plus a template proposal that they can fork to their own DAOs.
  2. A really short summary of the daoURI interface and architecture.
  3. Canonical list of all on-chain factory contract addresses.
  4. Updated version of
    The plans for DAOstar One - Overview of Architecture
  5. An answer to the following: "Could you point me towards one or more endpoint(s) you mentioned? I'd like to see which data is available to understand better what we could do with it."
  6. Super clear introduction to how to adopt. Side infographic on “How to create a contract transaction on… Gnosis Safe”.
@thelastjosh thelastjosh added documentation Improvements or additions to documentation help wanted Extra attention is needed priority: high High priority labels Apr 7, 2023
@thelastjosh
Copy link
Member Author

This week, we assigned Rashmi and unassighed Hazel and Aman to get this process started. Instead worrying about where this all goes, let's just pull all the information from everywhere into a Google Doc, and then we'll edit and consolidate/re-publish to more accessible places.

This lucidchart of various technical diagrams in DAOstar may be useful for you Rashmi: https://lucid.app/lucidchart/28e9f773-18b2-4e99-8e4c-dcb5ad3f1544/edit

@Rashmi-278
Copy link
Member

Starting this off with DAOStar Infrastructure Internal documentation which logs repos and info on where its deployed and the list of members who have access to it. This would be helpful during onboarding.
https://docs.google.com/document/d/1DUzFgCIkgQdHrHYn6NohT9in2K5NVVoeuFxw5Icj4Og

@thelastjosh
Copy link
Member Author

Rashmi built out the build / deploy and auth access documentation, will add to the repos themselves.

Other documentation still needed e.g.

  • contract addresses of all the deployed factory contracts and their versions.
  • all factories being indexed by our indexer.
  • swagger API

Where are our current readthedocs docs website? Why is that not online e.g. at docs.metagov.org.

@thelastjosh
Copy link
Member Author

Follow up in a couple weeks.

@Rashmi-278
Copy link
Member

Rashmi-278 commented Sep 6, 2023

Documentation for DAOstar contract registry and list of our indexer on different chains is in progress and can be found here
https://github.com/metagov/daostar#contracts-deployments

@thelastjosh
Copy link
Member Author

Today we just discussed moving as much as of docs as possible in to the main README.md file in the DAOstar repo. Rashmi will copy and paste a bunch of onboarding steps for adding chains there, we will just edit it directly.

@thelastjosh
Copy link
Member Author

A bit of progress this week from Rashmi.

@Rashmi-278
Copy link
Member

6 In progress.
I'm working on a clear instruction on how to adopt EIP 4824 Standard for all supported chains
5, Could we answer this question by providing them an example ?

@thelastjosh
Copy link
Member Author

Aman has been working on this! Draft (not yet public) is online at https://www.notion.so/daostar/e80c13a13f7146a5b2547f552b287beb?v=1d04dbfcb8a44d1e888651b6678e4b41 if you want access, message @amanwithwings

@Rashmi-278
Copy link
Member

We need to separate our Internal/Developer Docs and User Onboarding Docs.
The two links that Josh mentions at the beginning are dev docs and user docs.
I can work on developer docs easily as it's from a developer perspective developers

I Would need help from Josh, Aman, and anyone else who sees the bigger picture and helps new visitors understand the standards and why the EIP 4824 approach. what is our vision? how do we envision the adoption and usage of EIP 4824?

@Rashmi-278
Copy link
Member

Rashmi-278 commented Jan 1, 2024

The current status of this is,
Developer docs are reasonably up to date but there's a lot room for improvement.

Onboarding docs exist but they are dispersed and "Hidden" among links to Google Docs, notion, HackMD links

We need to consolidate them and provide links for them on daostar.org

@Rashmi-278
Copy link
Member

Rashmi-278 commented Jan 23, 2024

Added How to add new member logo.md documentation to DAOstar repo
https://github.com/metagov/daostar/blob/main/How%20to%20add%20new%20member%20logo.md

@Rashmi-278
Copy link
Member

Rashmi-278 commented Jan 23, 2024

Please review my comments made 3 weeks ago,
Next steps on this issue would be,

  1. Have a meeting to discuss what Developer Docs and User Docs would contain
    We would need, Me, Kahn, Mike, Josh, Aman, Hazel, Joni
    Me, Kahn and Mike can work on developer docs,

Aman, Hazel and Joni can weigh in on what would User Docs contain, maybe index the contents Joni and Aman worked on for GMX

  • Create a spec on what Developer Docs would contain and User Docs contain
  1. Approval on budget and management of Docusauraus from Josh
    https://docusaurus.io/docs/playground
    Developer Docs Can stay on Github Readme files
  • User Docs can go on Docusauraus

Quoting Josh here , context for push on Docusauraus

Publish a nice front-end version of the docs and add a link to the Docs resource to the top of the daostar.org website. E.g. ref. https://docs.attest.sh/docs/welcome

@Rashmi-278
Copy link
Member

To keep things simple for now, we are consolidating all docs here: https://daostar-public-docs.onrender.com

Disclaimer : This docs is work in progress and some info is still being worked on, please contact me if you need addition info or need anything added

@Rashmi-278
Copy link
Member

Here's the DAOstar Domain Setup: https://docs.daostar.org/

@thelastjosh
Copy link
Member Author

thelastjosh commented Mar 27, 2024

  • Just adding a task here: we need to erase the old documentation that's lying around the repo.

@amanwithwings
Copy link
Collaborator

Noting some of the things we discussed yesterday re:Documentation @frm, @Rashmi-278:

  1. Consider changing the order of content to make docs more approachable
  2. Add DAOIPs
  3. Improve the Introduction section
  4. Link it to the main website (perhaps the present Build button can be replaced with Docs, @thelastjosh?)

Not sure if I missed anything, feel free to add them!

@thelastjosh
Copy link
Member Author

thelastjosh commented Jun 26, 2024

docs.daostar.org is far better than what it was before, but not totally comfortable releasing it.

  • Keep editing.
  • Change "Build" link in daostar.org to "Docs". @Rashmi-278

@thelastjosh
Copy link
Member Author

thelastjosh commented Aug 16, 2024

Refreshing these two to do's:

  • we need to erase the old documentation that's lying around the repo. E.g. cut most of the stuff in the README.md on this repo. @Rashmi-278
  • Change "Build" link in daostar.org to "Docs". @Rashmi-278

@thelastjosh
Copy link
Member Author

@Rashmi-278 Please see items above.

@Rashmi-278
Copy link
Member

Checked all the DAOstar-related repo, and only the development build docs are in the readme file.
Except for the Members URI and Proposals URI API docs, will move it to docs and then erase them. But I would still like to API docs in the Readme file of API for better readability and access

Created a new issue to track it. #263

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 help wanted Extra attention is needed priority: high High priority
Projects
None yet
Development

No branches or pull requests

4 participants