Skip to content

docs: remove duplicate content from README and point to website - #167

Open
Champbreed wants to merge 1 commit into
oscal-compass:mainfrom
Champbreed:docs/remove-duplicate-content
Open

docs: remove duplicate content from README and point to website#167
Champbreed wants to merge 1 commit into
oscal-compass:mainfrom
Champbreed:docs/remove-duplicate-content

Conversation

@Champbreed

Copy link
Copy Markdown
Contributor

Removes duplicated content from the community README that now exists
on the OSCAL Compass website (https://oscal-compass.dev/community/).
The README is now specific to this repository and points to the
website for full project information, community meetings, and
project descriptions.

Closes #118

cc: @vikas-agarwal76 @degenaro

Signed-off-by: Simon Essien <champbreed1@gmail.com>
@Champbreed

Copy link
Copy Markdown
Contributor Author

Note: Community meetings, email, and Slack details were removed as
they exist on the website. Would add them back if preferred.

@Champbreed

Copy link
Copy Markdown
Contributor Author

While working on this issue, I noticed that docs/community.md in
the oscal-compass.github.io repo is manually maintained separately
from this README, which means both files still need to be updated
independently.

A better long-term solution would be to use the
mkdocs-include-markdown-plugin to have the website automatically
pull content directly from this README, eliminating the duplication
entirely rather than just reducing it.

Would the maintainers be open to a follow-up PR to implement this?

@degenaro

degenaro commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

@Champbreed Yes. Avoiding duplication is to strive for. Thx!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Remove duplicated content in the community repo

2 participants