Coder Social home page Coder Social logo

life-itself / web3 Goto Github PK

View Code? Open in Web Editor NEW
1.7K 33.0 189.0 13.85 MB

Making sense of web3 & crypto. Introduction to key concepts and ideas. Rigorous, constructive analysis of key claims pro and con. A look at the deeper hopes and aspirations.

Home Page: https://web3.lifeitself.org/

License: Creative Commons Zero v1.0 Universal

JavaScript 4.91% HTML 94.75% CSS 0.15% TypeScript 0.18%
awesome awesome-list blockchain cryptocurrency web3 technosolutionism bitcoin ethereum

web3's People

Contributors

andreass2501 avatar catherinet1 avatar cynicusrex avatar eilidhross1 avatar eilidhrosstest avatar evilpilaf avatar frbrkoala avatar gmax0 avatar guerda avatar hammyhavoc avatar khalilcodes avatar leafonthewind avatar martinthomson avatar max-arnold avatar molly avatar olarubaj avatar olayway avatar paullouisageneau avatar rufuspollock avatar salbayat avatar salty-horse avatar scroll avatar sdiehl avatar sebastianbuettrich avatar spookylukey avatar sprain avatar stevesong avatar theo-cox avatar ubiratansoares avatar valpackett avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

web3's Issues

Wiki links working

What we want: we want to be able to create links in our "wiki" (i.e. all our markdown files) that "work" (that is resolve) both within obsidian and when deployed on website. (We might also want them to work in github but i think that is less important frankly and that removes possibility of having [[...]] which is the nicest option).

Issue:

  • Inserting proper markdown links break on deployment because they include .md extension which gets removed on the website ie. [dao](../link/to/dao.md) in markdown does not work because webpage is /dao
  • Inserting wiki links does not work either [[xyz]] because [[...]] does not get processed to a link

We have tried redirect *.md but it turns out this is not possible in next.js => ❌

Best approach would really be a remark plugin that converts wiki links.

here is an effort for gatbsy which seems to do this, we can probably repurpose with a bit of effort: https://github.com/johackim/gatsby-remark-obsidian/blob/master/index.js

Obsidian Config

Currently we are configuring obsidian to replace wiki links with markdown file links

image

Deep Dive episode 5: incremental financial innovation

Acceptance

Tasks

  • Duplicate this Template and rename as the working title of the conversation
  • Create a new folder for the conversation here: TBC we need to link up on file storage
  • Source the video file and transcript from the conversation and add to folder
  • Create a document for the conversation that includes: Title, Conversation Summary, About the person in conversation, links to resources mentioned in the podcast, timestamps for at least two video excerpts and two quotes. Add this to folder.
  • Create Youtube video
    • Create the Youtube Thumbnail from this template.
    • Edit the video file in VN Editor:
      • Trim beginning and end, plus any sections of poor internet connection or other interruptions
      • Add thumbnail at the beginning of the video with a fade transition to the video
      • Add graphic overlay "Please Like & Subscribe" at the 5, 10, 20, 40 minute
      • Add End Screen with a fading transition
      • Increase the sound volume as much as possible without clipping the sound (you will notice because it will sound bad)
    • Export as Video and also Audio only
    • Upload to Youtube: Add title, thumbnail, summary, page stub URL, add to Web3 playlist, Add Language, Make License Creative Commons.
    • Notes from the conversation are on the webpage for that conversation.
      • Notes are complete, comprehensive and tidied
    • Inform Rufus and Stephen that youtube video is ready to go.
    • Publish
    • Ensure Rufus and Stephen tweet about video
  • Create Podcast
    • In Anchor click create new episode, use the "Intro Jingle" and add the audio only edit
    • Add title & summary (incl page URL)
    • Create and add thumbnail from this template
    • Add season number and episode number
  • Create Secondary Content
    • Cut the video excerpts from the main video
    • For reels, change the video for to 4:5 and the Canvas to 9:16 - Add this as a the background
    • Reduce video saturation to -100
    • Write subtitles overlay to go above the video on the background
    • Create Reel Cover using this template
    • For Twitter Keep the video excerpt as 16:9 format and add subtitles to the top of the video
    • Create Quote posts using this template
    • Add all content to the folder that has been created
  • Create Blog Post
    • Create a blog post beginning with the summary then embed the video, the podcast and include the transcript
    • Add the relevant quotes and video excerpts (Twitter format) as images between the transcript
  • Compile all the information in the Web3 Spreadsheet

Once blog is complete we can schedule content on Twitter, FB and IG

Resource Suggestion

I wonder if it'd be valuable to have a section pointing out some of the risks on a technical/market microstructure level to traders and consumers. Perhaps this might be too far down the rabbit hole.

Examples that come to mind (Ethereum DeFi risks)
https://arxiv.org/abs/2101.05511
https://arxiv.org/pdf/2009.14021.pdf
https://arxiv.org/pdf/2009.14021.pdf
https://www.coindesk.com/tech/2020/12/29/new-research-sheds-light-on-the-front-running-bots-in-ethereums-dark-forest/

https://www.singlelunch.com/2022/01/09/an-anatomy-of-bitcoin-price-manipulation/ (highly speculative, some interesting points nonetheless)

Checklist for deep dive episode processing

Creating a template issue for processing and releasing deep dives.

Acceptance

  • make page stub, generate URL for episode
  • Write blurb
  • Draft image
  • Upload youtube
    • Link page from youtube notes
  • Upload to anchor
  • (can be later) add show notes in raw form

Release

  • Make youtube public
  • Add youtube public link to deep dive page

Extras

  • Tidy show notes

"Edit this page" link at the bottom of pages

Add a "edit this page" link at the bottom of editable pages (i.e. "wiki" pages) so that a) our own team can easily edit pages b) others realize they can edit pages and some do so.

Context: All our content is here in github in markdown so people can directly correct it.

Acceptance

  • Edit this page or similar at the bottom of each page that comes from markdown/MDX source (so not home page for example)
    • so easiest way to implement is just to be a part of the MDX layout component
  • Links to correct "edit" version of page here on github e.g. /concepts/web3 links to https://github.com/life-itself/web3/edit/main/concepts/web3.md

A couple of oldies but goodies

  1. https://blog.gardeviance.org/2013/11/a-spoiler-for-future-bitcoin.html A prediction about Bitcoin made in 2013 by Simon Wardley. Particularly interesting bits are related to taxation issues
  2. https://hackernoon.com/ten-years-in-nobody-has-come-up-with-a-use-case-for-blockchain-ee98c180100 Very good comparison of various blockchain use-cases and how they are better solved by existing technologies
  3. https://medium.com/@kaistinchcombe/decentralized-and-trustless-crypto-paradise-is-actually-a-medieval-hellhole-c1ca122efdec A sequel for the previous blog post
  4. https://thecorrespondent.com/655/blockchain-the-amazing-solution-for-almost-nothing/84495599980-95473476 And the last piece is from 2020

Processing Rufus & Cory Doctorow Conversation

Rufus has recorded a conversation with Cory Doctorow and shared with Comms Team via email. This should be added to our processing backlog for web3 conversations.

Acceptance

  • Conversation is uploaded to podcast platforms Done
  • Conversation is listed on web3 site Done
  • (Optional) Conversation is uploaded to YouTube Done

Tasks

...

Show notes for first 3-4 episodes of deep dive are up

I suggest we get one fairly polished including front matter structure e.g. https://web3.lifeitself.us/notes/are-crypto-tokens-securities and then do the rest (though can prep the markdown for the others)

Acceptance

  • Episode 1 on neo-metallism ✅ https://web3.lifeitself.us/notes/neo-metallism
    • Page up with decent slug/url and title ✅ page up with appropriate title
    • Show notes ✅ Notes are up and formatted in line with the template
    • YouTube video ✅ Youtube video published and embedded in page
    • Podcast ✅ Podcast episode published and link in page
  • Episode 2 - trader ideology ✅ https://web3.lifeitself.us/notes/market-fundamentalism
    • Page up with decent slug/url and title ✅ page up with appropriate title
    • Show notes ✅ Notes are up and formatted in line with the template
    • YouTube video ✅ Youtube video published and embedded in page
    • Podcast ✅ Podcast episode published and link in page
  • Episode 3 - securities ✅ https://web3.lifeitself.us/notes/are-crypto-tokens-securities
    • Page up with decent slug/url and title ✅ page up with appropriate title
    • Show notes ✅ Notes are up and formatted in line with the template
    • YouTube video ✅ Youtube video published and embedded in page
    • Podcast ✅ Podcast episode published and link in page
  • Episode 4 - post state technocracy ✅ https://web3.lifeitself.us/notes/post-state-technocracy
    • Page up with decent slug/url and title ✅ page up with appropriate title
    • Show notes ✅ Notes are up and formatted in line with the template
    • YouTube video ✅ Youtube video published and embedded in page
    • Podcast ✅ Podcast episode published and link in page

FUTURE: (separate issue?)

  • set these up so we can feature them onto the front page automatically.

Tasks

...

Notes

Imagined frontmatter:

title:
description: # short description e.g. for use on front page or in meta
image: # image for use on front page and as page featured image
youtube: # youtube url - may not need this
date: # published date
authors: # array of strings e.g. [ 'Joe Doe', 'Jane Smith']

Pull items out of Zotero and display them

Pull items out of Zotero and display them. A subpart / follow up to #44

Tasks

  • Research options for doing this e.g. zotero API libraries or components
  • ...

Analysis

Research Libraries for Accessing Zotero

zotero/publications#71

This project is not developed anymore though it is maintained (and still in use). You won't be able to display entire library on your page using this library (without modifying it), it only works for "My Publications".

Web Library is actively developed and we're considering making a version that can be embedded.

For lower-level library, there is also zotero-api-client - which is what Web Library is using under the hood. It is actively developed and works in both Node and browser environment.

Frontmatter for deep dive pages - including editor instructions

Let’s store “structured” content for page in frontmatter e.g. image, description etc so that …

  • can do SEO tags for the page – these are pages where we have a specific description, image etc
  • can pull this info into the front page “Latest Releases”
  • can showcase this on a “deep dives” page

Acceptance

Tasks

  • Refactor one page to use frontmatter
    • Identify key frontmatter fields
      • key fields: title, date (published), description, (youtube, podcasts although can be left out)
      • other fields: image (thumbnail) and featured (defaulted to false), created, aliases
    • Update MDX component page template to display those fields if present
    • Add SEO based on the frontmatter fields
      • title, description and Image
  • Create a template for creating / editing deep dive pages
    • 'templates/' folder in root web3 for Obsidian
  • Update contentlayer to support these fields

Editor guide

  • create a template for these pages - BONUS: obsidian templates

Notes

Key front matter fields

Required for deep dive

  • title
  • date: publication date
  • description
  • image
  • featured: true - this will be used to determine whether featured on Latest Releases on front page

Optional ... (to be decided if we use these - if we have them all the time we could have a standard layout for these pages)

  • youtube
  • podcast

Note standard fields:

  • created: date this page in wiki was created (so more internal housekeeping)
  • aliases: obsidian field for aliasing pages

Bitcoin pyramid schemes wreak havoc on Brazil’s ‘New Egypt’

https://apnews.com/article/cryptocurrency-technology-business-brazil-bitcoin-2dc801e5e3aa477ce7983d84dc8a64bb

CABO FRIO, Brazil (AP) — In April, Brazil’s federal police stormed the helipad of a boutique seaside hotel in Rio de Janeiro state, where they busted two men and a woman loading a chopper with 7 million reais ($1.3 million) in neatly packed bills.

The detainees told police they worked for G.A.S. Consulting & Technology, a cryptocurrency investment firm founded by a former waiter-turned-multimillionaire who is the central figure in what is alleged to be one of Brazil’s biggest-ever pyramid schemes.

Police say the company owned by 38-year-old Glaidson Acácio dos Santos had total transactions worth at least $7 billion ($38 billion reais) from 2015 through mid-2021 as part of a Bitcoin-based Ponzi scheme that promised investors 10% monthly returns.

In hundreds of pages of documents obtained by The Associated Press, federal and state police and prosecutors accuse dos Santos and his associates of running a sophisticated racket defrauding thousands of small-scale investors who believed they were getting rich off Bitcoin’s steep appreciation. He is now in a Rio jail awaiting trial on charges including racketeering, financial crimes and ordering the murder and attempted murder of two business competitors. He remains under investigation in the attempted murder of a third competitor.

sort by year?

Under each thematic category, it might make sense to sort articles by year, creating 'year' subtitles, as the articles are often contextual to a rapidly changing landscape.

Video component for displaying youtube videos

YouTube component for displaying youtube videos.

See e.g. for https://web3.lifeitself.us/notes/are-crypto-tokens-securities where atm we just have the link.

What i want is:

<YouTube src='...' />

And this results in a nice responsive display via iframe or whatever - see e.g. https://www.themes.dev/blog/easily-embed-responsive-youtube-video-with-tailwind-css/

Acceptance

Tasks

  • ...

Sidebar table of contents

Maybe only on certain pages (markdown pages or guide or ...)

Inspiration from eg. tailwindcss.com which has LHS table of contents for whole site and RHS for table of contents of current doc - https://tailwindcss.com/docs/installation

image

Acceptance

  • RHS table of contents for the current page
  • LHS table of contents for the entire site (pages and sub pages ...)
    • Bonus for making this fancy e.g. highlight which page, allow for custom stuff at top a la tailwind etc

Tasks

Notes

Note tailwindcss docs is on github so we can learn from them on code side https://github.com/tailwindlabs/tailwindcss.com/tree/master/src

Taxonomy for Library plus inclusion criteria

Migrated out of #44 we have point about needing to structure the library better and to provide inclusion criteria as per this comment of @stevesong

Sounds good to me. I am a little concerned about the sheer volume of resources and the need to sort the wheat from the chaff. For a start it would be good to agree on a set of metatags for describing the resources. More ambitious would be some consensus on the best resources for a specific topic or best introduction to issues.

Acceptance

  • Basic taxonomy for tagging and organizing the library
  • Criteria or process for adding items to the library (deciding on inclusion)

Tasks

  • Summarize the current taxonomy
  • Look at SCQH and especially the issue tree and consider how that would influence a taxonomy
  • v0.1 of taxonomy (and/or inclusion criteria)
  • ...

Website v0.1

Launchable and announceable website.

Sketch of home page
website-homepage-v0.1-2022-02-23.excalidraw

Mockup of home page (design): https://excalidraw.com/#room=8bc8a0afb0afc89015dc,W3jd48r8_B2llA2CZ8A33A

Acceptance

  • Home Page
    • ⏫ Looks reasonable
    • Hero section
    • 🔼 Latest 2-3 videos up somewhere on the front page
    • Guide section
    • Library section
    • About the project
    • Contribute @EilidhRoss1 can you finish adding this ✅ Get Involved Section added
  • About page ✅ with SCQH
  • Library page
  • ⏫ Sign up to get updates / news …
  • Misc
    • ⏫ Analytics
    • Navbar
    • Social media image ✅ used front page screenshot
    • Footer
      • Social media links
      • License info

Bonus

  • Guide page

Tasks

Overview

Home Page

  • Hero
    • Layout
    • Fix "get updates"
      • EITHER: Remove "Get updates" & replace with CTA OR keep Get Updates using netlify form support => Choose what to do ✅ trying out netlify forms https://docs.netlify.com/forms/setup/ docs
      • Do it ✅2022-03-14 trying it out and seems to be working
  • Latest releases
    • Working
    • Replace images either with YouTube video embed or the thumbnail image (?) @eilidh
      • Upload images to cloudinary
      • Add to Latest Release section
  • Guide section
  • Library section
  • Why the project
  • Get involved (front page) ✅ Get Involved Section added

Library Page

Acceptance

  • /library landing page exists
  • brief overview
  • links to zotero
  • Also explanation of how to contribute incl organizational structure 🏃<U+200D>♂️ Done the first part and need to migrate the rest of the library contribute guide doc @EilidhRoss1

Tasks

  • Basic text for library page e.g. what, etc ✅ Eilidh written. Can be found here
  • Link or embed the full library

Guide

plan of content https://coggle.it/diagram/YidoEewvuAnxT9LA/t/web3-crypto-guide-toc

  • Stub /guide/ page and could reuse quite a bit of about as introduction

Contribute /contribute/

  • Developers => contribute on github
  • Non-developers
    • Researchers / academics etc
  • General: check out our videos and resources and Share the work with others
  • Feedback: share it on the discussions

Inbox

  • Logo and favicon (could auto-generate)
  • Issue tree image
    • Export it or embed? Export image
    • Make it simpler
  • can we use symlinks to display content from main part of the repo into the site itself ✅ Yes you can. Rufus has this working

NFT Authenticity vs Plagarism

The NFT page states:

Since multiple NFTs can be created that reference the same artwork there is n canonical guarantee of uniqueness that an NFT purchased is "authentic" and it remains unclear what "authentic" would mean regarding hyperlinks which are infinitely reproducible.```

This seems to be unaware of the paragraph immediately following, which acknowledges the source of such authenticity (by explaining the existence of NFTs which would be considered inauthentic):

Given the duplication problem above, many artists have critized NFT sales that involve plagarized versions of art whereby a pseudonymous party will "steal" or reference the work of another when deploying the smart contract allowing the third party to potentially profit off the work of another with no attribution or royalties paid to the original artist.

Announce v0.1

Announce the project and its newly released website home.

Acceptance

  • Announce posts up on Life Itself (and elsewhere)
  • Blurb for sharing prepped
  • Have x-posted announce to Emerge https://www.whatisemerging.com/opinions/web-3-a-crisis-of-sensemaking
  • List of places to announce in priority order
  • Announced at (most) of those places
    • Twitter (rufus & lifeitself etc)
    • Facebook
    • Instagram
    • ...
  • Mailing list mailout (?)

Tasks

Announcement post

  • Draft ✅ see https://docs.google.com/document/d/131PrBIBmBA5fzxGwgPhM_sNdUtHeFDq0AVIPhT_6BTw/edit# gdoc
  • Life Itself announce
    • ⏫ Put up the draft as a post (schedule for 16 March)
      • Find image originals (undraw, coggle etc), download high quality images, upload to cloudinary, embed in post
      • Set featured image set as same image as blog
    • Back post about original launch in Jan using current content of lifeitself.us/web3/ @EilidhRoss1
  • Publishing an intro piece on Emerge announcing the initiative ✅ Scheduled for 16 March

Sharing

Misc

  • Update current web3 page to redirect or point to new site

Sharing

Life Itself

Other places

Content Layer abstraction and replacement for next/mdx

Replace next/mdx and file based routing for markdown (wiki) content with a new content layer API based on https://github.com/contentlayerdev/contentlayer so that ...

Better markdown parsing

  • can use frontmatter again so that e.g.
    • we can e.g. youtube frontmatter and pull it out for front page
    • showing authors
    • sorting by diff types of page
  • we can use mdx in markdown w/o .mdx extension

We get a "content layer" API that allows us to ...

  • search for all concept pages at once so that we can list them easily
  • create a network map of concepts (?)

Acceptance

  • rendering all markdown files via a content layer system rather than next/mdx
  • index page for all "wiki" pages (?) at e.g. /all/
  • index page for concepts

Tasks

  • Create a site/content directory
  • Add contentlayer.dev modelling with a generic catch-all
  • Add catch-all nextjs route i.e. pages/[...slug].js
  • Move content over
    • *.md
    • concepts symlink
    • claims symlink
    • notes symlink
    • guide symlink
  • Fix titles
  • Create index page for all content
  • Create index page for concepts

Notes

Khalil notes

  • contentlayer.dev seems like a good approach.
  • Looks like there is one directory source for local files. Maybe would have to implement a workaround for that so that …
    • why do we need a workaround?). ✅ For the moment we are getting the data from the same repo. If we need to pull content from other repos? Why would we need to get data from other repos? (I can imagine situations of course). At the moment we don’t have that need …
    • What we do have is content in different directories. We solve this by symlinking them into a common directory called "content" or "data" e.g. symlink /claims => site/content/claims
    • Depends on what will be future content sources. Headless cms? Who knows … YAGNI
  • Any roadblocks faced when implementing for pages.datahub.io? No big ones.

Support Obsidian wiki link syntax in publishing to website

Obsidian extends basic markdown with special wiki-link syntax, transclusion and tags. As per https://obsidian.md/features

-   **[[Internal links]]**
-   **![[Filename]]** to embed notes and other files

Acceptance

Supports these types of links:

  • [[Internal link]]
  • [[Internal link|With custom text]]
  • [[Internal link#heading]]
  • [[Internal link#heading|With custom text]]

🚩 NB we assume that internal links are the right path - we don't do any kind of resolution. This is important to flag (?) somewhere as default obsidian behaviour is shortest path e.g. if actual path is abc/mynote.md obsidian with just have [[mynote]]

Transclusion links

May as well as do these even if for things other than images they won't really work.

🚩 need to think about how to do transclusion for things other than images. PDFs especially would be nice. (Other markdown docs is a bit complex as it requires an ability to pull that content ...)

  • ![[Embed image or note path]] => (in markdown) ![](Embed image or note path)
  • ![[Embed note#heading]] ❌ leave for now ...

Tasks

  • Research if existing remark plugin solutions exist ✅ Rufus has researched quickly and best option is below.
  • Create a new folder
  • Write a test (best if we can copy over!), probably just for basic string parser - we are doing TDD 😄
  • Get test passing
  • Get a proper test for remark plugin
  • Get it passing
  • Add docs to README
  • Publish to npm

Notes

existing remark solutions

Set page titles

At the moment we are not setting the page titles of any pages - it is always the same.

Acceptance

Tasks

  • Add titles to pages using slug.
    • ( frontmatter/meta doesn't exist for mdx pages for now. If implemented, will need to add frontmatter data for every md page. Do we need this ?

Why crypto and NFTs are the worst that happened with us

Editor guide

Guide for people contributing content or managing contribution of "wiki" content (so not front page but pretty much all other pages)

Acceptance

  • page exists on site for this e.g. /meta/guide or /meta/editing Guide is linked on this page of website: https://web3.lifeitself.us/meta/editing
  • has basic instructions for editing the site Guide includes instructions for editing directly on github and for editing using code editor or obsidian
  • Get involved section added to front page
  • Document frontmatter fields from #114 in editing guide

Tasks

Guide is finished and has been reviewed by @khalilcodes. Link to guide has been added to /meta/editing.md.

  • Stub a page
  • Introduction: Explain how site works and how you can edit See draft guide in progress here.
    • Wiki-like with sections
    • Technical architecture (?)
    • Use markdown
    • Editing
      • Edit direct on github
      • (More sophisticated) clone the repo and edit locally (using obsidian)
  • Markdown: this section introduces you to markdown. Already done here so can reference https://playbook.datopian.com/markdown/
  • Frontmatter: briefly explain what is frontmatter and why it is useful (look up in Obsidian info?)
    * [ ] Publishing flow: explain how the site gets published - mostly useful for developers but helps editors understand how stuff goes from github to the site **CT I don't think further detail on this beyond what is already implicit in the guide is necessary**
    * Github
    * Obsidian - our default editor. Markdown plus wiki stuff
  • explain how we want to put in youtube videos (simpler and we get responsive) included in frontmatter section
  • mention the deep dive template in editing guide in deep dive section
    * [ ] Add link to completed editor guide to README?
  • Add link to /meta/editing.md
  • Edit contribute page to link to /meta/editing.md.

[epic] Migrate "library" to Zotero (?)

What we have is essentially a bibliography. The proposal here is to adopt the Zotero reference manager as our backend storage for the bibliographic items.

Why do this change?

The main plus point of managing as README in git(hub) is:

  • Making it easy to have moderated contribution via pull requests etc
  • Quick publishing (it is just the github readme)
  • Stars ⭐ (so some sense of interest / attention)

However, this is not necessarily optimal, especially as the bibliography grows. For example:

  • Manual additions of new items including the key metadata
  • No standard format for items (a change in standard format requires
  • Painful to show the same item under multiple topics (manually copy and paste and if we correct anything needs correcting in multiple locations)
  • Re-organizing of topics requires manual work
  • No ability to sort by date or similar

Zotero + a renderer (static site) would seem to address a lot of this. At a minimum using zotero and very simple rendering should be able to reproduce what we have already and allow for easier addition of new material.

Acceptance

  • We have made choice about using (trialling?) Zotero
  • We have a working Zotero library and have migrated some items there
    • We have instructions for others on how to contribute
  • We have a PoC for how we get items back out and into a "README"

Tasks

  • Set out the reasons for doing this DONE. See Why below
  • Migrate content to Zotero (trial)
    • Boot Zotero group library DONE: https://www.zotero.org/groups/4600269/web3
    • Migrate a test set of items (e.g. the general section) from the awesome repo to the awesome/general Zotero folder
      • create an awesome subcollection
      • create a general subcollection of awesome collection (or do we use tags??)
      • Migrate items following the migration process set out below in analysis (and update as needed)
      • Write up notes for others
  • #52
    • Script converting this back into markdown
    • Research if any libraries / tools already exist in zotero ecosystem
    • Use one or or decide to roll our own
    • ...

Misc

  • @EilidhRoss1 take @catherinet1 through Zotero and record notes from this briefing into section below about using Zotero so that we can write it up for others

Analysis

How to Contribute to the Zotero Library

  • Install Zotero app
  • Install Zotero extension
  • Join the group library TODO

How to add Items / Migrate items

Aim: have "good" items where good means:

  • Has snapshot or PDF etc (auto-generated usually if you add from the extension)
  • Has proper metadata (full author name, date of piece, publication etc)

When migrating items:

  • Notes in notes section (paste without formatting)
    • Check if there is markdown support in Zotero notes field ...

How to contribute to Zotero

  • Create an account at zotero.org if you haven't already
    • Install the browser extension
    • (Recommend) Download the desktop app
  • Visit the group and click the join button https://www.zotero.org/groups/4600269/web3
  • Start adding materials (e.g. using the browser extension)

Markdown Citation Renderer: pandoc style citations => proper references

Want something like this in markdown:

Blah blah [@doe99; @smith2000; @smith2004].

To become this:

Blah blah (Doe 1999, Smith 2000, 2004).

Or, a fuller version like:

John Doe, "Frogs," *Journal of Amphibians* 44 (1999);
Susan Smith, "Flies," *Journal of Insects* (2000);
Susan Smith, "Bees," *Journal of Insects* (2004).

See pandoc for more: https://pandoc.org/MANUAL.html#extension-citations

🎁 Bonus: generating a reference section at the end of a document ie. list of citations. This could be something that is explicitly inserted by having a special item like [references] just like one has [toc] or maybe more MDX style <ReferencesList />

Acceptance

  • Clear description of what we want
  • Documented manual approach to doing this (i.e. manually add references to docs using obsidian)
  • Remark or similar plugin to do what we want
  • Document in editor guide

Tasks

  • Document our current flow for semi-manual addition of references @SMDiehl
  • Analyse what is needed for this to work e.g. do we need a bibtex file exported locally (or can we connect to zotero as part of the build or ...)
  • Create

Notes

Architecture

graph LR

a[Markdown file w/ citation]
b[Bibliography file with citation keys]
b2[Citation Style info]
c[Processor]
d[Output rendered file with proper citation]

a --> c
b --> c
b2 -.optional.-> c

c --> d

David Rosenthal article/talk summary

I love the collection of resources you have here; could I suggest an addition? https://blog.dshr.org/2022/02/ee380-talk.html Having built a decentralized consensus system using Proof-of-Work (http://dx.doi.org/10.1145/945445.945451) the author has the technical knowledge to explain the design faults and limitations of permissionless blockchain systems, as well as highlighting the economic and environmental issues. This might be the single best critique of web3 and cryptocurrencies I've read.

Rework root README.md now that site is launched

README.md at root of repo is what people currently see arriving here. We should probably revise it given that a) we now have the main site b) it is now the contribute path for devs

Suggest:

  • Move current README content into e.g. notes as awesome-crypto-critique or similar (easiest)
    • Someday we can move all the library items into the library and then build the page off that but until then ... this is KISS
  • Revise README with brief intro to project and instructions for devs and others (and perhaps a pointer to old awesome-cryto-critique content for people who arrive at github repo looking for that - we still have quite a few links on twitter etc to it)

Public Website v0.0.1

Initial version of an online home for the project (distinct from github itself!)

Acceptance

Tasks

  • Do analysis to select online location and framework
  • Skeleton website in nextjs v12
  • Add some skeleton content and layout
  • Set up deployment (e.g. netlify cloudflare pages)

Bonus

[inbox] Improvements to content presentation

Context: we are using a remark-based pipeline for converting markdown => html (all inside of a nextjs react app).

We are also tending to use obsidian to edit the content in the wiki (though you can use any markdown editor you like!).

Writing / Markdown

  • #99
  • Display videos nicely #88
  • Support proper obsidian wiki link syntaxes - #96
  • Citation rendering #91 ie. [@bernanke_essays_2004] work see eg. https://web3.lifeitself.us/concepts/gold-standard
  • Support additional obsidian markdown e.g.
    • GFM: table and task list, footnotes (?)
      | Markdown **table** |
      **- [x] Task list**
      
    • #Tags
    • $$LaTeX math$$

Big

Minor nice to have

WONTFIX

  • 🔽 link to good first issue stuff from contribute section WONTFIX. People who know what they are doing will work this out (?)

Content for Home Page v0.1

Create Web3 site front page

Acceptance

  • Web3 website front page published featuring copy and images found in google doc here

Tasks

  • Write copy (Title, Description and CTA) ✅ Eilidh done

    • Hero Section ✅ Eilidh done
    • Guide ✅ Eilidh done
    • Library✅ Eilidh done
    • Claims ✅ Eilidh done
    • Situation ✅ Eilidh done
    • Problems ✅ Eilidh done
    • Need ✅ Eilidh done
    • Approach ✅ Eilidh done
    • Get Involved ✅ Eilidh done
  • Collect images (svg) ✅ Eilidh done

    • Hero Section ✅ Eilidh done
    • Guide ✅ Eilidh done
    • Library ✅ Eilidh done
    • Claims ✅ Eilidh done
    • Situation ✅ Eilidh done
    • Problems ✅ Eilidh done
    • Need ✅ Eilidh done
    • Approach ✅ Eilidh done
    • Get Involved ✅ Eilidh done

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.