We’ve noticed a lot of comments about the lack of proper documentation for Beam, and we want to do our part as an active community project to help address this issue.
In addition to the cool sticker and guides we’ve already created, we suggest collecting and organizing all the guides that have been made by Raskul, Wilke, BeamBots, and others.
We can then add them to the official Beam Gitbook with a note indicating that they are community guides.
Team Beam, can you please comment on this or confirm that this will be added? We are eager to get to work on this right away
These are the locations where I have seen documentation and information (official and community) that is helping me with Beam:
- The main source is https://documentation.beam.mw (whose sidebar links to many docs hosted on https://beamx.gitbook.io).
- There are also some interesting pages on the main website that are not always very clearly referenced, like https://www.beam.mw/faq or https://beam.mw/beampedia. Maybe they are earlier versions of what is today in the main documentation?
- There are almost 100 pages of more technical information in the official GitHub wiki: Home · BeamMW/beam Wiki · GitHub.
- General information and some tutorials in the official Medium: BEAM Privacy. We could probably extract some sub-lists from it (history, information, tutorials, etc.).
- Same with Beam Africa’s Medium: Beam Africa – Medium.
- Raskul’s site (https://www.raskul.com) used to have some tutorials also, but since the site is down, they can now only be seen through Web Archive’s snapshots. We should probably scan them to extract and reference the interesting ones. This snapshot, by instance, has some Beam links in the top menu: https://web.archive.org/web/20220701171513/https://www.raskul.com/
- Some other resources in https://resources.beamprivacy.community.
- And some links (often old) in BitcoinTalk: [ANN] BEAM | Mimblewimble | Private | Scalable | No ICO | No Pre Mine.
- I also found interesting information here in https://forum.beam.mw, but it would need to be extracted from the threads and compiled… I guess the same can be said of the Telegram, Reddit or Discord groups.
Hi Beam team, just checking in to see if there’s been any progress on our request. We wanted to emphasize that we really think it’s very important. Thank you
This is a great initiative!
send over all the user guides/documentation you collect, Ill make sure to add it to Gitbook with proper credits to the creator.
I’ll be waiting for a DM from you guys
I referenced Etheruem homepage and they have a Tutorial section where you can find all the tutorials on how to write a contract.
I think we could have a button on the Beam main page which redirects directly to: Using Beam Shaders - Developer Documentation for those who are interested in developing smart contracts on Beam
Yes. I think the
faucet and the
vault are two good examples for which we could build a step-by-step tutorial on how to write a shader (since the tutorials on how to deploy them, afterwards, already exist).
Maybe we should start by asking Beam devs to add lots of comments and explanations in the source codes of these two examples?
Love this. Documentation is key. The team continuing to write documentation on how things work, examples of how to script custom dapps, etc… An amalgamation of community/external articles written, videos recorded, etc… about Beam. A searchable FAQ to easily point people to from chat rooms who have questions that have been repeatedly answered over and over by mods
Adding one important link for those wanting to start developing for beam (shaders, DApps, websites, etc.): The telegram group for dev support.