chore: adding new file structure #61
Conversation
contributor-beginner/CONTRIBUTING.md
Outdated
| ## Getting Help | ||
|
|
||
| ### Questions and Support | ||
| - **Discord**: Join the [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) #developer-experience channel |
There was a problem hiding this comment.
Let's remove this for now, or point to join.intersectmbo.org, Internal verification needed before openly sharing Join link for Discord.
There was a problem hiding this comment.
Made updates for these changes.
contributor-beginner/CONTRIBUTING.md
Outdated
|
|
||
| Thank you for helping make Cardano more accessible to developers worldwide! 🚀 | ||
|
|
||
| *For questions about contributing, reach out in the [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) #developer-experience channel.* No newline at end of file |
There was a problem hiding this comment.
You can leave this, just without the given/specified link to Discord. See above comment.
|
|
||
| - [Cardano Improvement Proposals (CIPs)](https://github.com/cardano-foundation/CIPs) | ||
| - [Formal Specifications](https://github.com/IntersectMBO/cardano-ledger#formal-specifications) | ||
| - [Technical Working Groups](https://intersectmbo.org) |
| ## Getting Involved | ||
|
|
||
| - **Core Development**: Contribute to [IntersectMBO repositories](https://github.com/IntersectMBO) | ||
| - **Research**: Engage with [IOG Research](https://iohk.io/en/research/library/) |
There was a problem hiding this comment.
You might also link to #research-working-group under Product Committee in Discord.
There was a problem hiding this comment.
The WG needs improvement before contributors can be referred to it. Members reported lack of engagement, difficulty getting feedback, lack of transparency - no minutes or recordings are available.
The only way to engage with the group currently is to read the post and try to contact Fergie
https://forum.cardano.org/t/ior-cardano-vision-work-program-2025-mid-year-report-fundamental-research-draft/148920
| 5. **Documentation & Open Source Awareness** – Teach newcomers how to contribute to repos, docs, and community resources | ||
| 6. **Community Alignment** – Reflect on 2025 achievements and build momentum for 2026 | ||
|
|
||
| ## Session Plan (12 Sessions) |
There was a problem hiding this comment.
Add dates, Session difference like A/B? And links back to the youtube recordings. @IntersectOSO
| ## Getting Started | ||
|
|
||
| ### For New Participants | ||
| 1. Join the [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) |
| ## Getting Involved | ||
|
|
||
| ### Join the Working Group | ||
| 1. Join the [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) |
| ## 🆘 Getting Help | ||
|
|
||
| ### 💬 **Community Support** | ||
| - **Discord**: Join the [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) #developer-experience channel |
|
What is the link for GH Pages per the Docusaurus edits? Thanks |
thisisobate
left a comment
thisisobate
left a comment
There was a problem hiding this comment.
I think it makes sense to merge some ideas from the original plan outlined in the readme (see it here) with already existing best-practices. Here's my proposition for the file structure:
docs/
├── how-to-guide/
│ ├── beginner/
│ │ └── readme.md
│ ├── intermediate/
│ │ └── readme.md
│ ├── advanced/
│ │ └── readme.md
├── tutorials/
│ ├── install-node.md
│ ├── run-docker-image.md
│ └── how-to-create-an-address.md
├── resources/
│ ├── repositories.md
│ ├── tools.md
│ └── community.md
├── working-group/
│ ├── q4-2025/
│ ├── q1-2026/
│ └── readme.md
└── getting-started.md
Things to note:
- The working group folder looks good so we don't have to change anything here
- This recommended change only affects the docs folder; other folders in the repo remain as is.
What do you think? @Emmanuel-Tyty @Ranchhand87
thisisobate
left a comment
thisisobate
left a comment
There was a problem hiding this comment.
Also, can we rename "contributor-beginner" to "website" instead? the latter better suites the context.
|
I agree, the previous cohort established a rather detailed but succinct nomenclature that should be retained. As far as re-naming to website, I think that is fine, but rather simplistic. No argumentative opinion. |
aleeusgr
left a comment
aleeusgr
left a comment
There was a problem hiding this comment.
I left some comments sharing my insights from leading this group in the past two years.
|
|
||
| ## Current Guides | ||
|
|
||
| ### Getting Started with Cardano |
There was a problem hiding this comment.
mention docs.cardano.org, developers.cardano.org, using the new AI-augmented search in particular
There was a problem hiding this comment.
Made updates from your sentiments, many thanks.
| ## Current Guides | ||
|
|
||
| ### Getting Started with Cardano | ||
| - **[Address Management](./address.md)** - Understanding Cardano addresses |
There was a problem hiding this comment.
|
|
||
| ### Getting Started with Cardano | ||
| - **[Address Management](./address.md)** - Understanding Cardano addresses | ||
| - **[How to Create Address](./howtocreateaddress.md)** - Step-by-step address creation |
| ### Getting Started with Cardano | ||
| - **[Address Management](./address.md)** - Understanding Cardano addresses | ||
| - **[How to Create Address](./howtocreateaddress.md)** - Step-by-step address creation | ||
| - **[Inputs and Outputs](./inputsandoutputs.md)** - Understanding transaction structure |
There was a problem hiding this comment.
Module 102 in https://plutuspbl.io/
For understanding inputs and outs consider learning basic Category Theory:
Types in programming correspond to objects in a category, seen as sets of possible values (e.g., an integer type corresponds to a set of integers). Functions correspond to morphisms/arrows between objects, representing transformations from input types to output types. The source and target of a morphism directly correspond to the input and output types of the function in programming. Composition of morphisms corresponds to function composition, where the output of one function can feed as input into another. Identity morphisms represent do-nothing functions that return their input unchanged.
| - **[How to Create Address](./howtocreateaddress.md)** - Step-by-step address creation | ||
| - **[Inputs and Outputs](./inputsandoutputs.md)** - Understanding transaction structure | ||
|
|
||
| ## Coming Soon |
There was a problem hiding this comment.
Recommend adding Version Control and Security to the Basics or Intermediate curriculum, as lack of skills here is a serious detriment to devex
https://input-output-hk.github.io/cardano-engineering-handbook/policy/vcs.html
https://input-output-hk.github.io/cardano-engineering-handbook/policy/security/index.html
|
|
||
| 1. **Check the troubleshooting section** in each guide | ||
| 2. **Join our Discord**: [Intersect Discord](https://discord.com/invite/RJWdVsMkvR) #developer-experience channel | ||
| 3. **Ask on Stack Exchange**: [Cardano Stack Exchange](https://cardano.stackexchange.com) |
There was a problem hiding this comment.
does stack exchange have anyone answering the questions?
when was the last question asked?
was it answered?
when was the last answered question posted?
how long did it take to get an answer?
what is median time to get an answer?
add reference to IOG technical community, gimbalabs discrods, forum.cardano.org
| - Introduction to Plutus | ||
| - Getting started with Aiken | ||
| - Building your first smart contract | ||
| - Testing smart contracts |
There was a problem hiding this comment.
refer to the section in the PPP
remind me to find John Hughes talk on using Quickcheck,
|
|
||
| ### Smart Contract Development | ||
| - Introduction to Plutus | ||
| - Getting started with Aiken |
There was a problem hiding this comment.
80% of devs globally are using TS; Midnight is also using Typescript. Therefore learning smart contract in typescript is more relevant than ever. https://helios-lang.io/ enables smart contract development in TypeScript with great documentation and is easy to use.
| - State management for blockchain apps | ||
|
|
||
| ### Developer Tools | ||
| - Setting up advanced development environments |
There was a problem hiding this comment.
If we rank the environments by time-to-productive, learning ladder will be Helios->Aiken->Haskell/Plutus
|
|
||
| ## Prerequisites | ||
|
|
||
| Before starting these guides, you should be comfortable with: |
There was a problem hiding this comment.
familiarity with docs.cardano.org, developers.cardano.org
…ctMBO/developer-experience into chore/new-structure-and-cleanups
|
#62 Ready for action. |
…ture-and-cleanups chore: adding new file structure
…ture-and-cleanups chore: adding new file structure
4 participants
No description provided.