-
Notifications
You must be signed in to change notification settings - Fork 108
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.
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] Add Section to Docs for accessing STIX #126
Comments
Review NotesReview notes as of commit 4ea4b89: Installation section: consider changing the note about requiring python3 to a bulleted sub-heading section called The Related MITRE Work should be tucked further down the list, IMO. The ReadTheDocs should prioritize pages relating to usage of the Same thing with the Contributing and Notice sections. IMO, these are less relevant to the ethos of this website and should be moved further down. I would re-structure it so that the flow goes from Introduction --> Installation --> Getting Started The Related MITRE Work -> CTI section says:
I would re-word this as:
The Related MITRE Work -> ATT&CK section includes a link to https://attack.mitre.org without any context. Consider wrapping this in a sentence like:
The Getting Started section isn't rendering some hyperlinks correctly:
This layout is confusing: is it referring to the "Additional Modules" heading section on the same page, or the "Additional Modules" link in the side pane? There is another broken hyperlink at the bottom of the Getting Started page:
The last sentence of the Additional Modules section appears to be formatted incorrectly:
Remove those pipes and wrap the I think that's about it for now. I will follow-up with more comments if I find anything. |
Over on the https://github.com/mitre/cti repository there is a Usage.md file that has information on "Accessing ATT&CK data in python". This section should be brought over to this repository's documentation since this is the official way that we recommend people should be accessing the STIX data.
The data in the USAGE.md file should be considered a starting point, and not necessarily just something to cut and paste over here, but can still be an educational resource for how we tackle parsing the data ourselves.
The text was updated successfully, but these errors were encountered: