Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mbaudis committed Oct 31, 2024
1 parent a561b35 commit f3128ae
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ The [documentation](https://bycon.progenetix.org/installation/#loading-and-maint

### 2024-10-21 (v2.0.3)

* bringing the documentaion into `bycon`
* bringing the documentation into `bycon`
- seriously using Python heredocs, starting with embedding the main information
about their functionality into the service caller functions
- project root `markdowner.py` now parses services (and some preference
Expand Down Expand Up @@ -337,7 +337,7 @@ a few parameters:
by a future parsing of simple statements like `t(8;14)(q24;q32)`
* moved some cytoband functionality to the main `bycon` package, from `byconaut`,
to allow processing of cytoband requests in the main Beacon service
* `byconaut` was restructured for exacutables, with `housekeepers` and `importers`
* `byconaut` was restructured for executables, with `housekeepers` and `importers`
directories

### 2024-03-25 (v1.6.4)
Expand Down
2 changes: 1 addition & 1 deletion docs/generated/services.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,7 +165,7 @@ None

## `/publications`

The _publications_ servive provides API functionality for accessing the
The _publications_ service provides API functionality for accessing the
Progenetix [publications](http://progenetix.org/publications/) collection, which
represents curated information about several thousand articles reporting
genome-wide screening experiments in cancer.
Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

The `bycon` project - at least at its current stage - is a mix of _Progenetix_ (i.e. GA4GH object model derived, _MongoDB_ implemented) - data management, and the implementation of middleware & server for the Beacon API.

Some features and pecularities of the `bycon` solution are:
Some features and pecularities of the `bycon` solution are:

* A single install can host multiple beacons and multiple datasets
and those can be intersected.
* `bycon` handles Beacon queries with full model aggregation; it does not
Expand All @@ -20,6 +21,7 @@ Some features and pecularities of the `bycon` solution are:
various file export formats beyond the standard JSON response.
* We provide several front-end projects of which one ([BeaconPlus](https://github.com/progenetix/beaconplus)) is a general version easily adaptible for individual use cases.


!!! info "Bycon Code"

The `bycon` code is maintained in the [`progenetix/bycon` repository](http://github.com/progenetix/bycon/). Some additional utility scripts & functions can be found in the
Expand Down

0 comments on commit f3128ae

Please sign in to comment.