Skip to content

Reorganize and revise documentation - #47

Merged
jondricek merged 10 commits into
mainfrom
doc-cleanup
Sep 22, 2025
Merged

Reorganize and revise documentation#47
jondricek merged 10 commits into
mainfrom
doc-cleanup

Conversation

@kji-mitre

@kji-mitre kji-mitre commented Sep 15, 2025

Copy link
Copy Markdown
Contributor

Consolidates documentation to reside in Docusaurus.

Adds templates for issues and pull requests to codify the contribution instructions.

@kji-mitre
kji-mitre marked this pull request as ready for review September 22, 2025 14:10
@kji-mitre
kji-mitre requested a review from jondricek September 22, 2025 14:11
Comment thread .github/pull_request_template.md Outdated
Co-authored-by: Jared Ondricek <90368810+jondricek@users.noreply.github.com>
Comment thread docusaurus/docs/contributing/index.mdx Outdated

## Developer Workflow

To maintain code quality and consistency, we use **ESLint**, **Prettier**, and **Husky** as part of the development workflow. These tools are installed and configured by the [Developer Setup](#developer-setup) steps above. Below is an overview of how each tool is configured and how it affects the contribution process:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To maintain code quality and consistency, we use **ESLint**, **Prettier**, and **Husky** as part of the development workflow. These tools are installed and configured by the [Developer Setup](#developer-setup) steps above. Below is an overview of how each tool is configured and how it affects the contribution process:
To maintain code quality and consistency, we use **ESLint**, **Prettier**, and **Husky** as part of the development workflow. These tools are installed and configured by the [Developer Setup](https://mitre-attack.github.io/attack-data-model/docs/contributing/dev-setup) steps. Below is an overview of how each tool is configured and how it affects the contribution process:

This is the right link now, but it talks about ESLint, Prettier, and Husky here - but not on the page linked.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! I've applied your recommended link correction but will work on the wording to clarify that the linked setup steps automatically handle the tool setup.

kji-mitre and others added 2 commits September 22, 2025 11:01
Co-authored-by: Jared Ondricek <90368810+jondricek@users.noreply.github.com>
@jondricek jondricek self-assigned this Sep 22, 2025
@jondricek
jondricek merged commit 8100217 into main Sep 22, 2025
2 checks passed
@github-actions

github-actions Bot commented Oct 8, 2025

Copy link
Copy Markdown

🎉 This PR is included in version 4.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants