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

Refactoring the Guide #181

Closed
19 of 20 tasks
theo-cox opened this issue Jun 17, 2022 · 15 comments
Closed
19 of 20 tasks

Refactoring the Guide #181

theo-cox opened this issue Jun 17, 2022 · 15 comments
Assignees

Comments

@theo-cox
Copy link
Contributor

theo-cox commented Jun 17, 2022

When I'm reading the guide, I want to an engaging route into the information that directly addresses my questions or perceptions.

Proposal of how we do this is outlined here, and involves merging the guide and claims page: https://docs.google.com/document/d/1woIRzvY6pdF43LQEFXHon1lUpIBe12Rj7WNZHXDdrnI/edit?usp=sharing

Note we should do this in Gdoc first, then convert to markdown and add to the site once the GDoc has been reviewed add signed off

Acceptance

  • All content (e.g. all site pages such as notes ad concept pages) is arranged in the guide in a structured fashion ✅2022-08-25 new guide is up https://web3.lifeitself.us/guide

Tasks

Refactored guide draft (WIP) is here

  • Count the total number of pages on the site (probably via exploring the GitHub repo) to ensure none are missed All .md files in site/content are listed in this spreadsheet
  • Draft better economy section @catherinet1
  • draft better society section @EilidhRoss1
  • draft financial liberty section @catherinet1
  • draft public goods problems section @EilidhRoss1
  • draft innovation & progress section @catherinet1
    - [ ] draft creative destruction section @EilidhRoss1 got rid of this aspiration/merged with innovation and progress or other aspirations
  • draft intro to guide
  • draft foundational concepts section ✅ See aspirations doc
  • integrate rest of concepts and notes pages ✅ See aspirations doc
  • Categorise in spreadsheet definitional concepts by topic ✅ Fixed
  • update refactored guide with new pages ✅ as of 27/07/22 the guide is up to date
  • refactor claims pages (?) see analysis ✅ all problematic claims pages are fixed
  • Fix any notes pages needing fixed. See comments in the spreadsheet ✅Reviewed Eilidh's comments and fixed all. Minimal edits made and decided to leave 'todos' given open-source/wiki nature of site. Opened an issue to track issue with images not showing.
    - [ ] Make glossary of concepts WONTFIX. Decided not worth doing this
  • Putting this issue tree at the top https://coggle.it/diagram/Yh-L7j5DfRykGi7e/t/web3-what-is-the-evaluation-polarizing-way-as-possible and speaking to it in the intro e.g. the main claims made in the space are... [as a related aside, I'd also avoid repeating our boilerplate text too much in the intro, as per he first para currently] ✅ See aspirations doc
  • Writing up descriptions of each aspiration and claim as full text rather than bullet points. E.g. "This section covers the aspirations of web3 to improve...by...It contains the following claims..." and "This claim states that web3 will achieve X by doing Y" ✅ See aspirations doc
  • Adding short evaluations of the claims e.g. "On the basis of current evidence, this claim seems [plausible, implausible, false, true, unknowable] under X conditions for Y reasons" ✅ See aspirations doc
  • Publish on site
    • Convert Google doc into Markdown: draft in hackMD (follow our style guide https://playbook.datopian.com/style-guide/markdown/ - and also note there is a plugin for google docs that auto converts to markdown and there are tools on the web to do this kind of conversion) ✅ drafted here
    • Transfer to guide/index page in repo and commit
@rufuspollock
Copy link
Member

@theo-cox reviewed the doc and looks excellent.

Also may want to check out our original plan issue in #77 (and close in favour of this?) plus @olarubaj thoughts in #144

@theo-cox
Copy link
Contributor Author

Great, thanks for the input @rufuspollock. Will close #77 as I think it would require a bit of extra content creation vs this refactoring. Think the thoughts in #144 are largely addressed by this, also, which is good!

@catherinet1
Copy link
Contributor

@EilidhRoss1 link to spreadsheet with all site pages listed is above

@catherinet1
Copy link
Contributor

@EilidhRoss1 @theo-cox I updated the issue with tasks completed and next actions

@EilidhRoss1
Copy link
Contributor

All pages in the site are now organized into the aspirations doc - except those concepts which don't contribute anything to any claim and which will go in an organized glossary section. All concepts have been categorized as economics, finance, tech, ideology, or social phenomena (open to different wording, esp on the social phenomena one). All unassociated concepts have been marked as such. Only other site pages which don't feature are some notes pages which as is (IMO) don't contribute anything or need quite a bit of editing before they should be in the refactored guide (all such notes pages have comments in the spreadsheet). TODO (as updated in issue): rewrite those claims which need rewritten (spreadsheet outlining which ones need fixed found here), fix any notes pages worth fixing and make the glossary.

@theo-cox
Copy link
Contributor Author

theo-cox commented Jul 6, 2022

Amazing work @EilidhRoss1 and @catherinet1 ! A handful of things that came out of the Labs meeting yesterday [which I'll put in the issue above]:

  • Putting this issue tree at the top https://coggle.it/diagram/Yh-L7j5DfRykGi7e/t/web3-what-is-the-evaluation-polarizing-way-as-possible and speaking to it in the intro e.g. the main claims made in the space are... [as a related aside, I'd also avoid repeating our boilerplate text too much in the intro, as per he first para currently]

  • Writing up descriptions of each aspiration and claim as full text rather than bullet points. E.g. "This section covers the aspirations of web3 to improve...by...It contains the following claims..." and "This claim states that web3 will achieve X by doing Y"

  • Adding short evaluations of the claims e.g. "On the basis of current evidence, this claim seems [plausible, implausible, false, true, unknowable] under X conditions for Y reasons"

@rufuspollock one final thing which we didn't get to chat through yesterday was some of the claims pages risk reading as overly inflammatory and biased, undermining our plausibility as a sensemaking resource. It's been suggested that we alter these, and it would be good to get your input here.

@EilidhRoss1
Copy link
Contributor

@theo-cox I've done these tasks (of course happy to make further edits) and have updated the issue

@rufuspollock
Copy link
Member

@rufuspollock one final thing which we didn't get to chat through yesterday was some of the claims pages risk reading as overly inflammatory and biased, undermining our plausibility as a sensemaking resource. It's been suggested that we alter these, and it would be good to get your input here.

I would be happy to see editing in line with this.

@theo-cox
Copy link
Contributor Author

Great! @catherinet1 and @EilidhRoss1 could you then action the changes you've flagged as necessary? We can then push the guide live! For ones about references etc Zotero should have lots of good stuff, but if you're unsure of anything then please do let me know. We can also discuss issues in Labs tactical next Tuesday

@EilidhRoss1
Copy link
Contributor

All claims pages have been appropriately fixed. The guide is up to date will all pages. I think we're moving onto the next stage which would be getting feedback from Theo and Rufus and then putting the guide into markdown and getting it up on the site!

@theo-cox
Copy link
Contributor Author

Having had a brief skim this looks great @EilidhRoss1 well done! My one comment would be its probably worth having a small sub-heading to separate the evaluation from the description. Other than that I'd say let's get it up asap!

@catherinet1
Copy link
Contributor

Updated Fix notes pages task.

@catherinet1
Copy link
Contributor

catherinet1 commented Aug 1, 2022

Having had a brief skim this looks great @EilidhRoss1 well done! My one comment would be its probably worth having a small sub-heading to separate the evaluation from the description. Other than that I'd say let's get it up asap!

Added sub-heading to separate evaluation from description

@theo-cox
Copy link
Contributor Author

theo-cox commented Aug 2, 2022

Great thanks @catherinet1! Really excited to see the finished product up on the site. You and @EilidhRoss1 have done an excellent job

@rufuspollock
Copy link
Member

rufuspollock commented Sep 7, 2022

FIXED. New guide is up at https://web3.lifeitself.us/guide.

Going to mark this as fixed as acceptance is done and for follow up see parent epic #193

Repository owner moved this from 🏗 In progress to ✅ Done in Backlog (All) Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

4 participants