Skip to content

Commit 054476e

Browse files
author
Beatriz Rizental
authored
Merge pull request #339 from mozilla/17120250-docs-links
Bug 1712050 - Add documentation links to README.md
2 parents 5812eac + 1545019 commit 054476e

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,26 @@
44

55
`Glean.js` is a modern approach for a Telemetry library aimed at Javascript environments. It is part of the [Glean project](https://docs.telemetry.mozilla.org/concepts/glean/glean.html).
66

7+
## Documentation
8+
9+
All documentation is available online:
10+
11+
### [The Glean Book](https://mozilla.github.io/glean/)
12+
13+
If you are using Glean.js in your project, this is the place to go.
14+
It contains user guides on getting started and other topics, as well as reference to Glean APIs.
15+
16+
### [Glean.js developer documentation](https://github.com/mozilla/glean.js/tree/main/docs)
17+
18+
If you want to contribute to the Glean.js code base this is the place to go.
19+
20+
### [Glean.js internal reference](https://mozilla.github.io/glean.js/)
21+
22+
If you are looking for detailed documentation on the Glean APIs (internal or external) this is the place to go.
23+
24+
_This documentation is autogenererated from the doc comments throughout the Glean.js codebase and
25+
the Glean book should be preferred over this documentation whenever possible._
26+
727
## Contact
828

929
To contact us you can:

0 commit comments

Comments
 (0)