Skip to content

Commit

Permalink
[docs] Fixes minor errors and typos in various doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
jacomyal committed Mar 15, 2024
1 parent 1f3c685 commit 36869d7
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 22 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

- **Completely rewrites programs API**
- **Renames all existing programs**
- **Restructures sources as a multipackage repository (using [Lerna](https://lerna.js.org/))**
- **Restructures sources as a multi-package repository (using [Lerna](https://lerna.js.org/))**
- **Moves the `node.image` renderer as a new package [`@sigma/node-image`](https://www.npmjs.com/package/@sigma/node-image)**
- **Moves `labelRenderer`, `hoverRenderer` and `edgeLabelRenderer` from settings to each renderer**

### Features
Expand All @@ -18,6 +19,7 @@
- [#1346](https://github.com/jacomyal/sigma.js/issues/1346) Adds documentation in the website
- [#1034](https://github.com/jacomyal/sigma.js/issues/1034) Adds new `Sigma.setCamera` method
- [#1185](https://github.com/jacomyal/sigma.js/issues/1185) Adds new `zoomToSizeRatioFunction` and `itemSizesReference` setting
- [#1231](https://github.com/jacomyal/sigma.js/issues/1231) Adds new [`@sigma/edge-curve`](https://www.npmjs.com/package/@sigma/edge-curve) renderer, as a new package

## 2.4.0

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ In this guide you will get an overview of the contribution workflow from opening

3. Test your contribution:

- Run the test suite locally: `npm run test && npm run e2e:test`
- Run the test suite locally: `npm run test`

4. Submit your contribution:

Expand Down
2 changes: 1 addition & 1 deletion LICENSE.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright (C) 2013-2021, Alexis Jacomy, Guillaume Plique https://www.sigmajs.org
Copyright (C) 2013-2024, Alexis Jacomy, Guillaume Plique https://www.sigmajs.org

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
Expand Down
24 changes: 5 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

## Overview

Here are some quick insights on the codebase. To know more on these topics, please read the [documentation](https://sigmajs.org/docs).
Here are some quick insights on the codebase. To know more on these topics, please read the **[documentation](https://sigmajs.org/docs)**.

### Architecture

Expand All @@ -28,32 +28,18 @@ You can install `sigma` (and `graphology` which is required for `sigma` to work)
npm install graphology sigma
```

## Examples
## Storybook

The [`examples`](https://github.com/jacomyal/sigma.js/tree/main/packages/examples) folder contains a series of self-contained TypeScript projects that you can either browse and edit on [CodeSandbox](https://codesandbox.io/) or install locally likewise:
The [`Storybook`](https://github.com/jacomyal/sigma.js/tree/main/packages/storybook) package contains a series of examples that you can either browse likewise:

```bash
git clone [email protected]:jacomyal/sigma.js.git
cd sigma.js
npm install
cd packages/examples
npm start --example=load-gexf-file # Change this to the desired example
npm run storybook:run
```

_List of available examples_

- [Fetching and displaying a graph contained in a gexf file](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/load-gexf-file) ([fallback link](https://sigmajs.org/examples/load-gexf-file))
- [Using node & edge reducers to handle interactivity](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/use-reducers) ([fallback link](https://sigmajs.org/examples/use-reducers))
- [Fetching, parsing & wrangling a CSV file to create a network map](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/csv-to-network-map) ([fallback link](https://sigmajs.org/examples/csv-to-network-map))
- [Handling drag and drop of nodes as well as node & edge creation on click](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/mouse-manipulations) ([fallback link](https://sigmajs.org/examples/mouse-manipulations))
- [Displaying arbitrary elements, such as cluster labels, synchronized with the network](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/clusters-labels) ([fallback link](https://sigmajs.org/examples/clusters-labels))
- [Applying different animated layout algorithms to a network](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/layouts) ([fallback link](https://sigmajs.org/examples/layouts))
- [Displaying nodes in various custom ways](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/custom-rendering) ([fallback link](https://sigmajs.org/examples/custom-rendering))
- [Saving the graph as a PNG image](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/png-snapshot) ([fallback link](https://sigmajs.org/examples/png-snapshot))
- [Use events to implement interactions](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/events) ([fallback link](https://sigmajs.org/examples/events))
- [See how sigma behaves with larger graphs](https://githubbox.com/jacomyal/sigma.js/tree/main/packages/examples/large-graphs) ([fallback link](https://sigmajs.org/examples/large-graphs))

Also, a more realistic sigma.js based web application is available in the [`demo`](https://github.com/jacomyal/sigma.js/tree/main/packages/demo) folder. It aims to show a real-world usecase, and is the main showcase of [sigma.js website](https://www.sigmajs.org/).
Also, a more realistic sigma.js based web application is available in the [`demo`](https://github.com/jacomyal/sigma.js/tree/main/packages/demo) folder. It aims to show a real-world use case, and is the main showcase of [sigma.js website](https://www.sigmajs.org/).

## Website

Expand Down

0 comments on commit 36869d7

Please sign in to comment.