Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Update README.md to include links to all docs #13

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Docs: Update README.md to include links to all docs #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ CMS code.json: An agency-wide metadata standard for software projects

This repository contains documentation on CMS code.json, a metadata standard used to collect information on the agency's software projects in compliance with [M-16-21](https://obamawhitehouse.archives.gov/sites/default/files/omb/memoranda/2016/m_16_21.pdf) and the [SHARE IT Act](https://www.congress.gov/bill/118th-congress/house-bill/9566/text/ih).

- [metadata.md](./docs/metadata.md): Overview on CMS code.json metadata standard
- [procedures.md](./docs/procedures.md): Procedures and tools on creating and updating metadata
- [examples.md](./docs/metadata_examples.md): Good examples of metadata in current agency code.json files
- [faq.md](./docs/faq.md): Frequently Asked Questions

### Project Vision

To streamline federal agencies' compliance with open source requirements that ensures consistent, accurate, and automated collection of software project metadata enabling transparency, traceability, and efficient risk management across the government.
Expand All @@ -28,10 +33,7 @@ An up-to-date list of core team members can be found in [MAINTAINERS.md](MAINTAI

## Documentation Index

- [metadata.md](./docs/metadata.md): Overview on CMS code.json metadata standard
- [procedures.md](./docs/procedures.md): Procedures on creating and updating metadata
<!-- TODO: Create examples.md once code.json is rolled out -->
<!-- - [examples.md](./docs/metadata_examples.md): Examples of metadata in current agency code.json files -->
- [docs](./docs)

## Repository Structure

Expand Down