Skip to content

Commit 388229c

Browse files
committed
feat: add CHANGELOG and enhance README with documentation navigation
1 parent 58e0c58 commit 388229c

File tree

3 files changed

+22
-2
lines changed

3 files changed

+22
-2
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Codebase Interface
2+
3+
This documentation will help you understand what changes have been made to this codebase and the service it provides.

LANGUAGE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ This documentation will help you understand the ubiquitous language used in this
55
| Term | Definition |
66
|-|-|
77
| Codebase interface | The codebase interface is the particular layer around a codebase that an audience will interact with to fulfil their needs. |
8+
| Service | The service is the functionality provided by the codebase. |
89
| Audience | An audience is a person or group of people that have a perspective from which they need to interact with a codebase. |
910
| Perspective | A perspective is the particular way an audience views a codebase. |
1011
| User | A user is an audience that has a need to interact with a codebase in order to use the eventual service it provides. |

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,26 @@
22

33
This documentation will help you understand how to use the service provided by this codebase.
44

5+
The codebase interface is a set of principles that aim to promote the ease of use of codebases across languages and frameworks for multiple audiences.
6+
7+
- [Codebase Interface](#codebase-interface)
8+
- [Badges](#badges)
9+
- [Docs Navigation](#docs-navigation)
10+
11+
## Badges
12+
513
[![Codebase Interface Principles](https://img.shields.io/badge/Codebase%20Interface-Principles-4b9ce2?style=flat-square&logo=semanticweb&logoColor=white)](https://codebaseinterface.org)
14+
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=flat-square)](https://conventionalcommits.org)
615

716
> This repository follows the **Codebase Interface Principles** — for a better experience for everyone who works with it.
817
9-
[![Codebase Interface](https://img.shields.io/badge/Codebase_Interface-Principles-blue?style=flat)](https://codebaseinterface.org)
18+
## Docs Navigation
1019

11-
_Follows the [Codebase Interface Principles](https://codebaseinterface.org)._
20+
| Link | Description |
21+
|-|-|
22+
| [CONTRIBUTING](CONTRIBUTING.md) | Guidelines for contributing to this service. |
23+
| [CHANGELOG](CHANGELOG.md) | A log of all notable changes made to this service. |
24+
| [LANGUAGE](LANGUAGE.md) | Ubiquitous language used for this codebase and service. |
25+
| [TODO](TODO.md) | Outstanding tasks and ideas for this service. |
26+
| [SUPPORT](SUPPORT.md) | Outstanding tasks and ideas for this service. |
27+
| [DOCS](docs/README.md) | Extended and online documentation for this service. |

0 commit comments

Comments
 (0)