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.

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

Remove 'asDiagram' infrastructure #5422

Merged
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
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
1 change: 0 additions & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ If your PR is the addition of a new operator, please make sure all these boxes a

- [ ] Add the operator to Rx
- [ ] It must have a `-spec.ts` tests file covering the canonical corner cases, with marble diagram tests
- [ ] If possible, write a `asDiagram` test case too, for PNG diagram generation purposes
- [ ] The spec file should have a type definition test at the end of the spec to verify type definition for various use cases
- [ ] The operator must be documented in JSDoc style in the implementation file, including also the PNG marble diagram image
- [ ] The operator should be listed in `docs_app/content/guide/operators.md` in a category of operators
Expand Down
2 changes: 2 additions & 0 deletions docs_app/.gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -47,3 +47,5 @@ Thumbs.db

# copied dependencies
src/assets/js/lunr*

assets/images/svgs/*
2 changes: 1 addition & 1 deletion docs_app/content/guide/operators.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ To explain how operators work, textual descriptions are often not enough. Many o

Below you can see the anatomy of a marble diagram.

<img src="assets/images/guide/marble-diagram-anatomy.svg">
<img src="../src/assets/images/guide/marble-diagram-anatomy.svg">

Throughout this documentation site, we extensively use marble diagrams to explain how operators work. They may be really useful in other contexts too, like on a whiteboard or even in our unit tests (as ASCII diagrams).

Expand Down
90 changes: 40 additions & 50 deletions docs_app/content/navigation.json
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
{
"TopBar": [
{
"url": "guide/overview",
"title": "Overview"
},
{
"url": "api",
"title": "Reference"
},
{
"url": "guide/v6/migration",
"title": "Migration"
},
{
"url": "team",
"title": "Team"
}
],

"TopBarNarrow": [],
"TopBar": [
{
"url": "guide/overview",
"title": "Overview"
},
{
"url": "api",
"title": "Reference"
},
{
"url": "guide/v6/migration",
"title": "Migration"
},
{
"url": "team",
"title": "Team"
}
],
"TopBarNarrow": [],
"SideNav": [
{
"url": "guide/overview",
Expand All @@ -28,8 +27,8 @@
{
"url": "guide/observable",
"title": "Observables"
},
{
},
{
"url": "guide/observer",
"title": "Observer"
},
Expand All @@ -41,26 +40,17 @@
"url": "guide/subscription",
"title": "Subscription"
},
{
{
"url": "guide/subject",
"title": "Subjects"
},
{
{
"url": "guide/scheduler",
"title": "Scheduler"
},
},
{
"title": "Testing",
"children": [
{
"url": "guide/testing/marble-testing",
"title": "Marble Testing"
},
{
"url": "guide/testing/internal-marble-tests",
"title": "Contribute tests to RxJS"
}
]
"url": "guide/testing/marble-testing",
"title": "Marble Testing"
}
]
},
Expand All @@ -69,16 +59,16 @@
"title": "Installation",
"tooltip": "Installation"
},
{
"url": "api",
"title": "Reference",
"tooltip": "RxJS Reference"
},
{
"tooltip": "Operator Decision Tree",
"url": "operator-decision-tree",
"title": "Operator Decision Tree"
},
{
"url": "api",
"title": "Reference",
"tooltip": "RxJS Reference"
},
{
"tooltip": "Operator Decision Tree",
"url": "operator-decision-tree",
"title": "Operator Decision Tree"
},
{
"title": "About Version 6",
"children": [
Expand All @@ -98,9 +88,9 @@
]
},
{
"url": "resources",
"title": "External Resources",
"tooltip": "External Resources"
"url": "resources",
"title": "External Resources",
"tooltip": "External Resources"
},
{
"url": "code-of-conduct",
Expand All @@ -109,4 +99,4 @@
}
],
"docVersions": []
}
}
Loading