#Roast My Docs

# Roast My Docs [Kickoff] ## Agenda During this Kick-off session, we'll be pairing individuals into groups of two. To keep things fair and fun, we'll let a picker wheel make the call for us! These sessions are going to be governed entirely by people attending the call. Everyones a collaborator, think of this as an unconference. We will be voting directly through HackMD (1 'x' per person pls!) Kickoff & subsequent calls will be: 1. Recorded & Posted on X 1. Recorded & Posted on YT 1. Recorded but not posted anywhere (kept as a list of unlisted videos shared between ourselves) 1. Not recorded Vote: 1 - [xxxx] <= Add x's here 2 - [xxx] <= Add x's here 3 - [xxx] <= Add x's here 4 - [xxxxxx] <= Add x's here For the next call, we will be: 1. Going all in. Every group takes turns in judging each other's documentation in a rapid fire fashion. K/Os accepted 🙏 2. 2 groups in a session. 30 mins dedicated to each group. 3. 4 groups in a session. 15 mins dedicated to each group. 4. Screenshare a doc and everyone voices their opinion! Once all groups are exhausted, we rotate! Vote: 1 - [x] <= Add x's here 2 - [x] <= Add x's here 3 - [x] <= Add x's here 4 - [xxxxxxxxxxxxxxxxxxxxxxxxxxxxx definitely x] <= Add x's here ## Participants & Introductions 1. WalletConnect [Boidu] 1. Mode [Fede] 2. MatterLabs [Coogan] 3. Consensys [Laurel/Oliver] 4. 0xRivendell [Shriraj] 5. Particle Network [Tabasco/Ethan] 6. Flock [Timothy] 7. Thirdweb [Youtube Owner/Atharva] 8. Last [Anett] 9. Fluentlabs.xyz [Krinza] 10. Berachain [Manny/@codingwithmanny] ## Best Docs Site The assumed: - Stripe - Optimism -> more on educational side - fleek.co - Base -> not the most dev - ThirdWeb (old one) - nextjs? [xxxxxxxx] - Alchemy (?) - Digital Ocean - HardHat - Foundry - Family - Wevm ## Rules Nada Everythings governed by folks attending the call. If they decide somethings out of bound, so be it. ## When's the next session? You tell me. What does everyones availability look like? Same time in 2 weeks? Vote: Yes - [xxxx] <= Add x's here No - [x] <= Add x's here ## Whats next? Research about your opponent's docs, bring your everything in the next sesh See ya soon! --- # Roast My Docs - Mode Edition ## Agenda Before starting, we're gonna have a quick discussion about anything thats trendy in the space, got something on your mind or something you saw on your twitter feed? We're all ears! After that, we're roasting [Mode Network Docs](https://docs.mode.network/)! Do your research and bring your A-game (also note things you like about it, we'll save those for the end!) Finally, before dropping, we'll decide who we roast in the next session. To keep things fair and fun, we'll let a picker wheel make the call for us! ## Discussion Topics - 4844 (obviously) ## Picker Wheel Candidates - WalletConnect - ZKSync (winner (?)) - Cookbook ## Quotez Hall of Fame - "Web3 is hard - so many new topics people have to learn first" - Derrek - "Long form tutorial completion went up 443% on Youtube" - Patrick - DevRel: Hired to be the Jack of All Trades. Fired because you're a Master of None. - Patrick --- # Roast My Docs - ZKSync Edition Before starting, we're gonna have a quick discussion about anything thats trendy in the space, got something on your mind or something you saw on your twitter feed? We're all ears! After that, we're roasting [ZKSync Docs](https://docs.zksync.io/)! Do your research and bring your A-game (also note things you like about it, we'll save those for the end!) Finally, before dropping, we'll decide who we roast in the next session. To keep things fair and fun, we'll let a picker wheel make the call for us! ## Discussion Topics - Dubai !!!!!! - Landing page too minimalist, paragraph on top, have some descriptions, etc. - Fede: Diataxis: - Fede: ZK Credo maybe not the right spot. - Confusion around Credo being in the repo - Page break leading to right content - Sarah: https://www.apollographql.com/tutorials/browse - Simple Walkthroughs allow comfort ## Picker Wheel Candidates - ## Quotez Hall of Fame - "I've worked with a lot of clients on Diataxis, and by a lot I mean three" --Fede # Roast My Docs - LayerZero Edition Before starting, we're gonna have a quick discussion about anything thats trendy in the space, got something on your mind or something you saw on your twitter feed? We're all ears! After that, we're roasting [LayerZero Docs](https://docs.layerzero.network/v2)! Do your research and bring your A-game (also note things you like about it, we'll save those for the end!) ## Discussion Topics - Layerzero CA's (and the process of automating it) - Segmented Docs (Progressive Disclosure) - Derrek & Matthews' Segment - [D] How Big is your team... etc - [M] Team of 4 ppl, everybody makes docs contrib, different subroles, EVM & SVM docs - [D] Do you have access to beautify ✨ docs? - [M] Yep - [D] Less is More is a good north star to shoot for - [D] https://docs.layerzero.network/v2/developers/evm/getting-started is overwhelming, new devs might be intimidated - [D] Visual Diagrams & info on what LZero is might be helpful - [M] Bytes manip is something I'll take a look at this quarter. Technical skill gap to ease people into. Is docs best strategy to approach or video? - [D] Maybe understand Cross chain messaging exists. Mental Model for docs - they open docs when they have a problem. Lots of signposts (make it easier for people to find) , e.g, typesense, Factoring content on sidebars is worth a lot of attention. Finding what youre looking for is half the battle. E.g. Marketting wants to call it Bob Gateway => should say bridge from Bitcoin to BOB instead (easily understandable by user). If something what the company would support as initiative (with help of marketing budget for pushing products) - [M] SHIP SHIP SHIP (But what can they do with our prodocts). Also yes we do. - [D] Do the yt vids, do paid spends on yt vids if valid for niche - make extremely approachable. Dont assume anything - "maybe they know what foundry & hardhat is" (DONT DO THIS!) - [M] Nightmare to walk-through, easy to make cli tools to automate processes. Wonder if theres a fast path/dumbed down version - [D] Biased, use scaffold-eth - very clean + nextjs hardhat foundry, (talking about pre idea, pre launch, using lzero as core infra, dont mind starting from a fresh repo, doesnt mind opinionated setup) - [M] Trying to cover two areas together (beginner & advanced), may be bad for both (?) - [D] Being tailored to use cases is important, what do they need exactly, where do i put content? Avatar based writing helps a lot with empathy, cannot write something optimized for both audience. Write twice. - [M] Beginner vs advanced section in docs, is it worth it? - [D] AWESOMEEE!! super visually differentiated beginners section vs advanced. (Doesnt highlight developers so might feel lost). Thoughts on diff Atharva? - [A] Against. - [M] Libs easy to use, call 2-3 functions and good to go. Much diff mental model than what theyre used to. Non evm bytes 32 & normal bytes 20. Have to pad before sending 13 slots. Might be confusing. Why does the dev care? Syntax changes they might not be used to coming from strict worlds of EVM or others - [D] highest data point? which chains - [M] TLDR EVM <=> EVM - [D] Created confusion for everyone even though most are EVM <=> EVM. Interesting case study for prod users feedback loop - [M] Biggest problem with any cross chain - isolated islands get info through passages/channels. If you upgrade the bridge interface, someone can start writing to it and modify world state since its SSOT. Have to add access conrols at protocol levels. can lead to DX issues - [D] Good DX vs Long term usability. Maybe hackathon dev wants to do things as quickly as possible. Maybe someone else, lots of users, may prefer the later. Tradeoffs. ## Quotez Hall of Fame -