Skip to content

Commit

Permalink
restructure documentation and include missing information on installm…
Browse files Browse the repository at this point in the history
…ent and elements widgets
  • Loading branch information
ThijsVroegh committed Jun 21, 2024
1 parent 4d49b87 commit b9d8dab
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 4 deletions.
19 changes: 16 additions & 3 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,25 @@ Widgets
-------

.. toctree::
:maxdepth: 1
:maxdepth: 2
:caption: Getting Started

widgets/actoranalysis
widgets/install
usage
known issues

.. toctree::
:maxdepth: 2
:caption: Widgets

widgets/actionanalysis
widgets/settinganalysis
widgets/actoranalysis
widgets/elements
widgets/narrativenetwork
widgets/settinganalysis




Indices and tables
==================
Expand Down
9 changes: 8 additions & 1 deletion doc/widgets.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@
[
"Orange Story Navigator",
[
{
{
"text": "How to install the widget",
"doc": "widgets/install.md",
"icon": "../orangecontrib/storynavigation/widgets/images/storynavigator_logo.png",
"background": "#C0FF97",
"keywords": ["install", "Orange", "installation","Add-on"]
},
{
"text": "Actor Analysis",
"doc": "widgets/actoranalysis.md",
"icon": "../orangecontrib/storynavigation/widgets/icons/actor_analysis_icon.png",
Expand Down
15 changes: 15 additions & 0 deletions doc/widgets/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Known Issues
=======
![](../../doc/widgets/images/storynavigator_logo.png)


For questions, suggestions, etc you contact us as follows:

**1**

Lead Applicant information


**2**

eScience?
21 changes: 21 additions & 0 deletions doc/widgets/knownissues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
Known Issues
=======
![](../../doc/widgets/images/storynavigator_logo.png)


The following is a list of known issues as part of working with the Orange3 StoryNavigator Add-on:

**1**

.....


**2**

......

**3**

......

**This list of issues can be further updated in the future.**
6 changes: 6 additions & 0 deletions doc/widgets/usage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
How to enable StoryNavigator in Orange
=======
![](../../doc/widgets/images/storynavigator_logo.png)


Coming soon

0 comments on commit b9d8dab

Please sign in to comment.