Comments (1)
Regarding the Asciidoc dialect I think the priorities should be:
- The PDF target
- The HTML target
- Look OK directly on github
I do not know right now what that means for the style guide. We could start by adding these priorities to the style guide and then as we discover what works and what doesn't work we can add specific guidelines.
If someone knows a set of Asciidoc guidelines which we could start from please let me know.
Some other things that the guidelines should cover:
- How to mark/comment early drafts
- How to mark/comment missing sections where contributions are more than welcome
- What type of callout to use and for what (note, warning erc.)
- How to link to the OTP code
- Where to place files (code, screenshots, diagrams, etc) and how to handle them (Makefile, code listing appendix)
- How to tag chapters, sections, figures
from thebeambook.
Related Issues (20)
- Beam instructions appendix HOT 4
- Possible wording issue in scheduling section with regards to reduction checking HOT 1
- BEAM instruction table bleeds into Code listsings in appendix HOT 3
- Inspecting message handling example HOT 4
- Misprint or not? HOT 1
- Typo on BEAM instructions HOT 2
- Broken image URLS in "What is a Process?" section HOT 3
- Usage of + around inline code isn't affecting rendered form.
- Please continue being awesome HOT 2
- Atom no longer mandatory HOT 2
- HTML Entity for * (*) is not rendered properly
- Possible typo in section "7.2 BEAM code listings" HOT 2
- Add support for Chinese? HOT 1
- Heap fragment diagram is broken ?
- Missing words / Typo in The Erlang Type System section
- Chinese Translation Request
- The message passing chapter maybe a little outdated HOT 1
- Incorrect Extended Literal Tag
- Links in section 1.4 (Other Erlang Implementations) are dead
- Compilation Failure
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from thebeambook.