Skip to content

Commit

Permalink
Improvement for Docs (#460)
Browse files Browse the repository at this point in the history
* Added an icon on the welcome page

* Better icon for gallery

* Using more commonly supported icons

* Added the online sandbox playground

* Added a online sandbox intro page

* Words

* Added a tab grid to the getting started landing page

* Words and new links

* Matching graph icon on the landing page
  • Loading branch information
kennethshsu authored Sep 14, 2023
1 parent 9918309 commit c5c0a10
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 19 deletions.
14 changes: 11 additions & 3 deletions docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,25 @@
::::{grid}
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`chevron-right;2.5em;sd-mr-1` Try Online
:link: getting_started/sandbox_intro.md
:link-type: doc

Try chainladder online.
:::

:::{grid-item-card} {octicon}`desktop-download;2.5em;sd-mr-1` Installation
:link: install
:link: install.md
:link-type: doc

How to install chainladder
How to install chainladder.
:::

:::{grid-item-card} {octicon}`beaker;2.5em;sd-mr-1` Tutorials
:link: tutorials/index
:link: tutorials/index.md
:link-type: doc

Our beginner tutorials.
:::

::::
28 changes: 13 additions & 15 deletions docs/getting_started/online_sandbox/sandbox_intro.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
# {octicon}`chevron-right` Try Online

Before you go through the trouble of installing the package on your machine, why not give it a try online first? There's no reason to spend the time with getting your enviroment set up. Now you can explore what `chainladder-python` can do without any installation hassle. Give it a shot now and see for yourself!
Before you go through the trouble of installing the package on your machine, why not give it a try online first? There's no reason to spend the time with setting up your dev enviroment, if you end up finding out that this is not useful to you. Save the time so you can spend it reconciling your data instead.

If you are already familiar with a programming language, you should be able to get thorugh this sandbox tutorial in **about an hour**. While knowing python is not really required for this sandbox tutorial, you'll want to brush up your basic python skills before working on the Onboarding Tutorials.
If you are already familiar with a programming language, you should be able to get through this sandbox tutorial pretty quickly. While knowing python is not really required for this sandbox tutorial, you'll want to brush up your basic python skills before working on the more in depth Onboarding Tutorials following installation.

This sandbox tutorial is set up for you to "fill in the blank". Basically, most of the code is already completed, except for a small piece of code in each line for you to fill in.
This online sandbox tutorial is set up for you to "fill in the blanks". Basically, most of the code is already completed, except for a small piece of code in each line for you to fill in. It's up to you to figure out what goes in there, but we, the code volunteers are ready to answer any questions you may have, on GitHub.

Time recommended: **1 hour**

- [Presentation Deck](https://docs.google.com/presentation/d/13JtlCODvNjAF62SQyF_TLnvGk8FuBOOn4L3LeDqxjbQ/edit#slide=id.g14a01cc18bb_0_0)
- [Lite Demo Workbook](https://github.com/casact/chainladder-python/blob/master/docs/library/2022_cas_annual_meeting/demo-blank-concurrent.ipynb)
- Open in [Google Colab](https://githubtocolab.com/casact/chainladder-python/blob/master/docs/library/2022_cas_annual_meeting/demo-blank-concurrent.ipynb) (faster, Google Account required)
- Open in [Binder](https://mybinder.org/v2/gh/casact/chainladder-python/master?urlpath=treedocs/library/2022_cas_annual_meeting/demo-blank-concurrent.ipynb) (slower, no sign up required)
You can open the sandbox tutorial in one of two ways. You may be forced to use one or another, especially if you are a company network with strict network firewall rules.

Other Resources:
- [Chainladder-Python's GitHub](https://github.com/casact/chainladder-python/)
- [CAS's GitHub](https://github.com/casact/)
- [Actuarial Open Source](https://actuarialopensource.org/)
- [The Actuary and IBNR Techniques: A Machine Learning Approach](https://deliverypdf.ssrn.com/delivery.php?ID=731070114084107029112030090019092127058062071092084057031006123078008013125027108099057029023099109125023090100018002120091125040057062033063080127003007019073011006073066010070116122002109103099127107020127111111065095019102084011005006064111002022121&EXT=pdf&INDEX=TRUE) by Caesar Balona & Ronald Richman
- FASLR (Free Actuarial System for Loss Reserving): GUI of Chainladder-python by Gene Dan
- [GitHub](https://github.com/casact/FASLR)
- [Gene's Blog](https://genedan.com/)
- Open in [Google Colab](https://githubtocolab.com/casact/chainladder-python/master/docs/getting_started/online_sandbox/demo-blank-concurrent.ipynb) (faster, but a free Google Account is required)
- Open in [Binder](https://mybinder.org/v2/gh/casact/chainladder-python/master/docs/getting_started/online_sandbox/demo-blank-concurrent.ipynb) (slower, no sign up required)

<!-- # old stuff -->
<!-- - Open in [Google Colab](https://githubtocolab.com/casact/chainladder-python/blob/master/docs/library/2022_cas_annual_meeting/demo-blank-concurrent.ipynb) (faster, but a free Google Account is required)
- Open in [Binder](https://mybinder.org/v2/gh/casact/chainladder-python/master?urlpath=treedocs/library/2022_cas_annual_meeting/demo-blank-concurrent.ipynb) (slower, no sign up required) -->

Just in case you want a copy of the sandbox tutorial notebook, you can download it [here](https://github.com/casact/chainladder-python/blob/master/docs/getting_started/online_sandbox/demo-blank-concurrent.ipynb).
2 changes: 1 addition & 1 deletion docs/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Install chainladder and try the beginner tutorials.
A more comprehensive guide on the capabilities of chainladder.
:::

:::{grid-item-card} {octicon}`grabber;2.5em;sd-mr-1` Galllery
:::{grid-item-card} {octicon}`graph;2.5em;sd-mr-1` Galllery
:link: gallery/index
:link-type: doc

Expand Down

0 comments on commit c5c0a10

Please sign in to comment.