jamesplease / fi-calc-guide

The guide book for FI Calc

FI Calc Guidebook

The Guidebook for FI Calc.

Contributing

Looking to help out? Refer to the Contributing Guide. Also, thanks!

Target environment support

• All evergreen browsers (including Edge)
• Android mobile browsers, iOS mobile Safari, iPadOS Safari

This app is not expected to work in Internet Explorer.

fi-calc-guide's Issues

Add Google Analytics

Concatenate CSS

Add endowment strategy equation to guide

Update CHANGELOG

• New guides
• Search!

Export guide + restructure nav

• Usage Guides
  • Exporting Results
  • Saving Simulations
  • Sharing Simulations

Memorize scroll position across reloads

using sessionstorage:

https://twitter.com/hakimel/status/1262337514741706752?s=21

Document enabling/disabling income/withdrawal

This will require updating the summary image

Site roadmap

• Introduction
• Why Backtesting Is Useful
  • Criticisms of Backtesting
• Withdrawal Strategies
  • By Groups
  • Attributes
• Historical Data
  • Criticisms of Dataset
• Statistics
  • Median
  • Average

Dark/light mode toggle

• Toggle in UI
• Store in LocalStorage
• Read from LocalStorage; prefer over MatchMedia

Images throughout guides

First release

• Finish remaining pages (aside from withdrawal strat pages)
• Test on mobile
• Release

Fix nav in Firefox

Prob boils down to it not supporting max() for --contentSpacingLeft

Collapsible nav sections

Add btn styles

Add Babel step for JS

It is annoying having to avoid ES2015+

Refactor external JS

host them on ficalc.app

everything except goog ads code

Subnav: light mode support

Figure out VSCode integration

• Prettier
• template highlighting

More robust search

Atm any small tweak to the site can break the search index, because of the way that the JSON is generated. Perhaps it's possible to enable search per-directory, so that I don't need to worry about every new file breaking the index?

Add light/dark mode support

I'll need to add some JS to support the toggle

Prevent scroll when nav is open

Add search

• Search index (JSON file using eleventyone as an example)
• Search page that uses that data
• Search bar
• Visual design
• Search bar works on mobile
• Search icon

Add if/then for page title

KaTeX example

Steps:

1. Add katex: true to the frontmatter
2. Put KaTeX in the Markdown

i.e.;

---
layout: default
title: About
katex: true
---

# Header

Cool math:

$\sqrt{3x-1}+(1+x)^2$

Hosted dataset viewer

View all of the data in an app. Then, each year in the docs can link out to the data spreadsheet

Nav: hover state for expand/collapse icon

Cache busting: CSS file with suffix

for cache-busting

Separate JS file?

Atm it's inlining the JS for each file. I should think about if a separate JS file would be preferable; perhaps for some of it? Not too sure.

Thanks for the tool

Just found your tool. It is, I am sure, very very more complex than it seems on the outer edge. The graphs and tools you put to our disposal are fantastic, way higher quality than any other open source project I've seen.

BTW why do you think there is such a low amount of personal finance code on github? Feels like there should be a toolset for all of us to share and contribute to...

Withdrawal strategy guides

• Add blog post links
• Add attribution to creator
• Add year of creation (if known)
• Add links to other resources (i.e.; calculator)
• Add more descriptions for individual form fields (specifically the newest withdrawal strats)
• Tips
  • i.e.; guardrails for variable withdrawal strats, life annuity for VPW
• Algorithm details (i.e.; PMT fn)
• Equations (using LaTeX)

---

Attribute ideas:

Volatility. How much do withdrawals change year-over-year?
Reliability. How likely is it to run out of money before the retirement ends?
Legacy. Typical final portfolio size? Large or small?
Spending. Average total spending over the life time of the retirement?
Simplicity. How simple is the withdrawal algorithm?

Add launch calculator btn to header

Host docs on docs branch