This repository was archived by the owner on Sep 24, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 8
Create API_overview.md #22
Open
valeriahhdez
wants to merge
7
commits into
main
Choose a base branch
from
10-chronologue-docs-how-chronologue-api-works
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
595a561
Create API_overview.md
valeriahhdez 91c4764
Update API_overview.md
valeriahhdez b15766c
Update API_overview.md
valeriahhdez 6a9e3d7
Update API_overview.md
valeriahhdez 6a4a270
Update API_overview.md
valeriahhdez 17adeea
Update API_overview.md
valeriahhdez 9d49920
Update API_overview.md
valeriahhdez File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,62 @@ | ||
|
||
## About the Chronologue API | ||
<br> | ||
|
||
The Chronologue API is open-source interface that provides data about astronomical events. You can easily query astronomical data stored in the API and visualize events on the Chronologue website. | ||
|
||
The main purpose of the Chronologue API is to help scientists and organizations advance humanity's knowledge. To query and visualize an astronomical event, you need an HTTP client, for example, a web browser. | ||
|
||
The Chronologue API follows a REST architecture. You can access the API's resources via HTTP requests and responses are given in JSON format. | ||
|
||
|
||
<br> | ||
|
||
## Main features | ||
<br> | ||
|
||
The Chronologue telescope records astronomical events of the past and the future. It stores the events in a [data.json] file (https://github.com/thegooddocsproject/chronologue/blob/main/data/data.json) as event objects. You can use the Chronologue API to query exisiting astronomical events from the `data.json file`. | ||
|
||
If you want to retrieve data for an event that does not yet exist, you have to make a request to record a new recording. | ||
|
||
> Note: The Chronologue telescope predicts future events, but the accuracy of these predictions is not guaranteed. | ||
|
||
Read and follow the steps described in the "Request for a new recording" document. Fill out and submit the provided form and, if your request is approved, you will receive a notification email with access to the Chronologue API. | ||
|
||
|
||
<br> | ||
|
||
|
||
|
||
 | ||
A high-level diagram of the Chronologue API's workflow. | ||
|
||
|
||
|
||
<br> | ||
<br> | ||
|
||
## Use cases | ||
<br> | ||
|
||
- **Academic research** | ||
|
||
Gather information with the Chronologue API to further humanity's understanding. You can visualize past events that can help you explain what circumstances caused a another phenomenon of nature. | ||
|
||
Use the Chronologue API to test your hypothesis. The Chronologue API can make predictions about future astronomical events. You can compare your predictions to those prouced by the API as a way to validate your hypothesis. | ||
Comment on lines
+43
to
+45
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Love these use cases! 👍 |
||
|
||
<br> | ||
|
||
- **Educational purposes** | ||
|
||
Demonstrate to your audience the causal relationship between two natural events. For example, you can show your students the asteroid's impact on Earth during the Cretaceous Period that caused the mass extinction of three-quarters of plant and animal species. | ||
|
||
---------------------------------------------------------------------------------------------- | ||
|
||
## How to contribute | ||
|
||
Developers can contribute to the software by joining the Chronologue Project, which is part of The Good Docs project. To contribute to program code, you should be familiar with the following tools: | ||
|
||
- Next.js | ||
- Netlify hosting infrastructure | ||
|
||
To learn more, join our [Slack community](https://thegooddocs.slack.com/) or attend a [Chronologue meeting](https://thegooddocsproject.dev/community/). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.