GithubHelp home page GithubHelp logo

Comments (1)

happi avatar happi commented on June 8, 2024

Regarding the Asciidoc dialect I think the priorities should be:

  1. The PDF target
  2. The HTML target
  3. 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)

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.