mapbox / mapbox/cpp

Docs on ABIs

Open
#55 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
No language data
Stars
110
Forks
17
PR merge metrics
No merged PRs in 30d

Description

We should have beginner docs on ABI and how it should be understood by C++ developers and users. Going to use this ticket as a place to drop links that will be potential resources when writing up this doc.

/cc @allieoop for visibility as we've talked about how important understanding ABI compatibility is for the design of mason

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No target file, test, or documentation entry point is named. Start by reviewing the existing repository documentation and the linked ABI resources as they are collected, then define beginner-focused coverage for ABI compatibility in C++ and its relevance to mason. Done means the agreed ABI concepts are explained clearly for C++ developers and users.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.