AboutCode Documentation¶
Welcome to the AboutCode documentation.
This set of documents provides an overview of the AboutCode Projects sponsored by AboutCode.org (https://www.aboutcode.org), as well as references to the various GitHub project sites that maintain the actual projects and their documentation.
All community contributions are welcome. Note that AboutCode.org is applying to participate in the 2020 Google Season of Docs (GSoD 2020).
- AboutCode Project Overview
- AboutCode Data : ABCD
- Summary
- Context
- ABCD: the AboutCode Data structure
- Basic objects describing data about code
- Attribute Names and Values
- Name conventions
- Value conventions
- Object identifiers
- Organizing data and relationships
- Document format conventions
- References between documents and payload, embedding other files
- Document-as-files naming, exchange and storage
- Documenting and validating attributes
- Notes on YAML format
- Notes on JSON Format
- Notes on embedding ABC Data in source code files.
- Notes on spreadsheet and CSV files
- Coding Principles
- Documentation Guidelines
- GSoC – Google Summer of Code
- GSoD – Google Season of Docs
- License