Skip to content

Refactor global docs, schemas reference, and API reference for independent versioning #49

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

Jump to bottom
Open
wants to merge 48 commits into
base: main
Choose a base branch
from
Open

Refactor global docs, schemas reference, and API reference for independent versioning #49

wants to merge 48 commits into from

Conversation

@kji-mitre
Copy link
Contributor

@kji-mitre kji-mitre commented Oct 7, 2025 •
edited
Loading

Description of what has changed

Refactors the schemas reference, and API reference into separate plugins from the global docs (default plugin) and versions them independently. The global docs are un-versioned.

The conditional rendering of the schema and api doc-version dropdown menus is implemented in docusaurus/src/css/custom.css.

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?

kji-mitre added 15 commits October 1, 2025 16:31
@kji-mitre
chore(docs): configure multi-instance for schema versioning
bdcbb5e
@kji-mitre
chore(docs): rename schema docusaurus instance to schemas
1435c62
@kji-mitre
chore(docs): move schema reference from docs to schemas docusaurus in…
f80b2cf 
…stance
@kji-mitre
chore(docs): move api reference from docs to api docusaurus instance
1be494c
@kji-mitre
chore(docs): refactor docusaurus pages
bd2c063
@kji-mitre
chore(docs): correct broken docusaurus links
e1c8700
@kji-mitre
chore(docs): fix broken compatibility links
f02a330
@kji-mitre
chore(docs): fix broken stix-bundle link on schemas page
385c136
@kji-mitre
chore(docs): fix broken links in tutorials
249dc1c
@kji-mitre
chore(docs): rename api doccard header
9e42979
@kji-mitre
chore(docs): split docusaurus homepage reference doccard
a8a5ed7
@kji-mitre
chore(docs): pretend current docs are a cut release
08f315c
@kji-mitre
chore(docs): only display doc version selector for currently selected…
b51cb1a 
… doc instance
@kji-mitre
chore(docs): cut versions of api and schemas docs
7527ab9
@kji-mitre
chore(docs): update docusaurus readme
be2e217
@kji-mitre kji-mitre changed the title Versioned schemas and API docs Refactor global docs, schemas reference, and API reference for independent versioning Oct 7, 2025
@kji-mitre kji-mitre requested a review from jondricek October 7, 2025 16:47
@kji-mitre kji-mitre marked this pull request as ready for review October 7, 2025 16:48
jondricek and others added 21 commits October 13, 2025 12:45
@jondricek
docs: refactored SPEC.md into multiple pages
8e2db53
@jondricek
docs: add architecture component
2b9cae4
@jondricek
docs: update stix architecture diagram positioning
b5f35a7
@jondricek
docs: don't generate stix bundle schema docs
a5065df
@jondricek
docs: remove unwanted content from API section
cfdc980
@jondricek
docs: update version of zod2md
aae85fa
@jondricek
docs: add new detections stix page
961f996
@jondricek
docs: update 3.3.0 schema changelog with another deprecated field
bb94a28
@jondricek
docs: move descriptions from SPEC.md to schema files
d96a4b5
@seansica
Merge branch 'main' into doc-cleanup
144ef21
@seansica
style: apply formatting
85c9634
@seansica
ci: stop tracking package-lock and use npm install within github actions
99aeecd
@seansica
build: replace ts-node with tsx
f3f87da
@jondricek
chore: update spacing
09dd20c
@jondricek
fix: add missing dependencies to generate markdown docs
abac73e
@jondricek
docs: update docusaurus version
32731ba
@jondricek
docs: add npm script to generate schema markdown files
3f751d7
@jondricek
ci: use updated npm script to generate schema markdown files
7003818
@jondricek
docs: remove old gendocs npm script
3c9e8fd
@jondricek
docs: add missing dev dependency
3b8f901
@jondricek
docs: generate special markdown page for Software
f38351b
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jondricek jondricek Awaiting requested review from jondricek

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kji-mitre @jondricek @seansica