Skip to content

Commit e1bc917

Browse files
author
David Joy
committed
docs: fixing service-interface path
1 parent b334701 commit e1bc917

File tree

3 files changed

+14
-7
lines changed

3 files changed

+14
-7
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,12 @@
1111

1212
frontend-platform is a modest application framework for Open edX micro-frontend applications and their supporting libraries. It provides a number of foundational services that all Open edX micro-frontends should have:
1313

14-
- Analytics
14+
- Analytics
1515
- Logging
1616
- Authenticated API client (auth)
1717
- Internationalization (i18n)
1818

19-
In addition, frontend-platform provides an extensible application initialization lifecycle to help manage the configuration of the above services, freeing application developers to focus on feature development.
19+
In addition, frontend-platform provides an extensible application initialization lifecycle to help manage the configuration of the above services, freeing application developers to focus on feature development.
2020

2121
## Architecture
2222

@@ -37,19 +37,19 @@ The initialization process proceeds in a series of phases, giving the initializi
3737
- Authentication service initialized
3838
- Analytics service initialized
3939
- Internationalization service initialized
40-
- Application ready
40+
- Application ready
4141

4242
Most applications won't need to do anything special at all.
4343

4444
### Service interfaces
4545

46-
Each service (analytics, auth, i18n, logging) provided by frontend-platform has a API contract which all implementations of that service are guaranteed to fulfill. Applications that use frontend-platform can use its configured services via a convenient set of exported functions. An application that wants to use the service interfaces need only initialize them via the initialize() function, optionally providing custom service interfaces as desired (you probably won't need to).
46+
Each service (analytics, auth, i18n, logging) provided by frontend-platform has a API contract which all implementations of that service are guaranteed to fulfill. Applications that use frontend-platform can use its configured services via a convenient set of exported functions. An application that wants to use the service interfaces need only initialize them via the initialize() function, optionally providing custom service interfaces as desired (you probably won't need to).
4747

48-
![Service interface](https://github.com/edx/frontend-platform/blob/master/docs/service-interface.png)
48+
![Service interface](service-interface.png)
4949

5050
### Service implementations
5151

52-
This repository contains default service implementations for convenience. These implementations are co-located with their consuming service interfaces for ease of development, though the two should remain _strictly_ modular and separate.
52+
This repository contains default service implementations for convenience. These implementations are co-located with their consuming service interfaces for ease of development, though the two should remain _strictly_ modular and separate.
5353

5454
The included service implementations are:
5555

jsdoc.json

+8-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,14 @@
1616
"cleverLinks": false,
1717
"monospaceLinks": true,
1818
"useLongnameInNav": false,
19-
"showInheritedInNav": true
19+
"showInheritedInNav": true,
20+
"default": {
21+
"staticFiles": {
22+
"include": [
23+
"./service-interface.png"
24+
]
25+
}
26+
}
2027
},
2128
"opts": {
2229
"destination": "./docs/api",
File renamed without changes.

0 commit comments

Comments
 (0)