docs: improve readme, move roadmap to docs/

This commit is contained in:
Vyacheslav Matyukhin 2022-03-24 02:59:29 +03:00
parent ce6d253d64
commit fe021c458e
No known key found for this signature in database
GPG Key ID: 3D2A774C5489F96C
2 changed files with 7 additions and 2 deletions

View File

@ -6,8 +6,6 @@ This repository includes a source code for the website, as well as a set of libr
We also provide a public database, which can be accessed with a script similar to [this one](./src/backend/manual/manualDownload.js). We also provide a public database, which can be accessed with a script similar to [this one](./src/backend/manual/manualDownload.js).
(source code in `src/pages/` and `/src/web/`).
I also created a search engine using Elicit's IDE, which uses GPT-3 to deliver vastly superior semantic search (as opposed to fuzzy word matching). If you have access to the Elicit IDE, you can use the action "Search Metaforecast database". However, I'm not currently updating it regularly. I also created a search engine using Elicit's IDE, which uses GPT-3 to deliver vastly superior semantic search (as opposed to fuzzy word matching). If you have access to the Elicit IDE, you can use the action "Search Metaforecast database". However, I'm not currently updating it regularly.
[![](./public/screenshot.png)](https://metaforecast.org) [![](./public/screenshot.png)](https://metaforecast.org)
@ -45,6 +43,13 @@ $ npm install
$ node src/backend/manual/manualDownload.js $ node src/backend/manual/manualDownload.js
``` ```
## Code layout
- frontend code is in [src/pages/](./src/pages/), [src/web/](./src/web/) and in a few other places which are required by Next.js (e.g. root-level configs in postcss.config.js and tailwind.config.js)
- various backend code is in [src/backend/](./src/backend/)
- fetching libraries for various platforms is in [src/backend/platforms/](./src/backend/platforms/)
- rudimentary documentation is in [docs/](./docs)
## What are "stars" and how are they computed ## What are "stars" and how are they computed
Star ratings—e.g. ★★★☆☆—are an indicator of the quality of an aggregate forecast for a question. These ratings currently try to reflect my own best judgment and the best judgment of forecasting experts I've asked, based on our collective experience forecasting on these platforms. Thus, stars have a strong subjective component which could be formalized and refined in the future. You can see the code used to decide how many stars to assign [here](./src/backend/utils/stars.js). Star ratings—e.g. ★★★☆☆—are an indicator of the quality of an aggregate forecast for a question. These ratings currently try to reflect my own best judgment and the best judgment of forecasting experts I've asked, based on our collective experience forecasting on these platforms. Thus, stars have a strong subjective component which could be formalized and refined in the future. You can see the code used to decide how many stars to assign [here](./src/backend/utils/stars.js).