UPDATE: Documents reorganization and some additions

This commit is contained in:
Nicolás Hatcher
2024-11-24 00:39:42 +01:00
committed by Nicolás Hatcher Andrés
parent 97846041e5
commit 48afb45eb9
14 changed files with 147 additions and 43 deletions

1
docs/.gitignore vendored
View File

@@ -1,2 +1,3 @@
src/.vitepress/cache/* src/.vitepress/cache/*
src/.vitepress/dist/*
node_modules/* node_modules/*

View File

@@ -38,63 +38,93 @@ export default defineConfig({
sidebar: [ sidebar: [
{ text: "About IronCalc", link: "/index.md" }, { text: "About IronCalc", link: "/index.md" },
{
text: "Web Application",
collapsed: true,
items: [
{ text: "About the web application", link: "/web-application/about" },
{ text: "Importing Files", link: "/web-application/importing-files" },
{ text: "Sharing Files", link: "/web-application/sharing-files" },
],
},
{ {
text: "Features", text: "Features",
collapsed: false, collapsed: true,
items: [ items: [
{ text: "Formatting Values", link: "/features/formatting-values" }, { text: "Formatting Values", link: "/features/formatting-values" },
{ text: "Using Styles", link: "/features/using-styles" }, { text: "Using Styles", link: "/features/using-styles" },
{ text: "Keyboard Shortcuts", link: "/features/keyboard-shortcuts" }, { text: "Keyboard Shortcuts", link: "/features/keyboard-shortcuts" },
{ text: "Importing Files", link: "/features/importing-files" }, {
text: "Error Types",
link: "/features/error-types",
},
{ text: "Unsupported Features", link: "/features/unsupported-features" },
], ],
}, },
{ {
text: "Functions", text: "Functions",
collapsed: false, collapsed: true,
items: [ items: [
{ text: "Database", link: "functions/database" }, { text: "Database", link: "/functions/database" },
{ text: "Date and Time", link: "functions/date-and-time" }, { text: "Date and Time", link: "/functions/date-and-time" },
{ text: "Engineering", link: "functions/engineering" }, { text: "Engineering", link: "/functions/engineering" },
{ {
text: "Financial", text: "Financial",
collapsed: true, collapsed: true,
link: "functions/financial", link: "/functions/financial",
items: [{ text: "FV", link: "functions/financial/FV" }], items: [{ text: "FV", link: "/functions/financial/fv" }],
}, },
{ text: "Information", link: "functions/information" }, { text: "Information", link: "/functions/information" },
{ text: "Logical", link: "functions/logical" }, { text: "Logical", link: "/functions/logical" },
{ {
text: "Lookup and Reference", text: "Lookup and Reference",
link: "functions/lookup-and-reference", link: "/functions/lookup-and-reference",
}, },
{ {
text: "Math and Trigonometry", text: "Math and Trigonometry",
link: "functions/math-and-trigonometry", link: "/functions/math-and-trigonometry",
}, },
{ text: "Statistical", link: "functions/statistical" }, { text: "Statistical", link: "/functions/statistical" },
{ text: "Text", link: "functions/text" }, { text: "Text", link: "/functions/text" },
], ],
}, },
{ {
text: "Python bindings", text: "Programming",
collapsed: true, collapsed: true,
items: [ items: [
{ {
text: "Practical Guide", text: "Rust",
link: "python-bindings/python-bindings-practical-guide", link: "/programming/rust",
},
{
text: "Python",
link: "/programming/python-bindings",
},
{
text: "JavScript",
link: "/programming/javascript-bindings",
}, },
], ],
}, },
{ {
text: "More", text: "TUI Application: Tironcalc",
collapsed: true, collapsed: true,
items: [ items: [
{ text: "Unsupported Features", link: "more/unsupported-features" },
{ text: "How to contribute", link: "more/how-to-contribute" },
{ {
text: "Understanding Error Types", text: "About Tironcalc",
link: "more/understanding-error-types", link: "/tironcalc/about",
}, },
{
text: "Installing and basic usage",
link: "/tironcalc/installing",
},
],
},
{
text: "Contributing",
collapsed: true,
items: [
{ text: "How to contribute", link: "/contributing/how-to-contribute" },
], ],
}, },
], ],

View File

@@ -4,7 +4,7 @@ outline: deep
lang: en-US lang: en-US
--- ---
# Understanding Excel Error Types # Error Types
::: warning ::: warning
**Note:** This page is in construction 🚧 **Note:** This page is in construction 🚧
@@ -66,6 +66,13 @@ When working with formulas, you may encounter these common errors:
**Cause:** Incorrect range operator in a formula (e.g., missing a colon between cell references). **Cause:** Incorrect range operator in a formula (e.g., missing a colon between cell references).
**Fix:** Use correct range operators (e.g., A1:A10). **Fix:** Use correct range operators (e.g., A1:A10).
### **`#CIRC!`**
**Cause:** Circular reference.
**Fix:** Remove the circular reference.
### **`#####`** ### **`#####`**
**Cause:** The column isnt wide enough to display the value. **Cause:** The column isnt wide enough to display the value.

View File

@@ -3,25 +3,25 @@
layout: doc layout: doc
outline: deep outline: deep
hero: # hero:
name: "IronCalc Documentation" # name: "IronCalc Documentation"
text: "The documentation of IronCalc" # text: "The documentation of IronCalc"
tagline: My great project tagline # tagline: My great project tagline
actions: # actions:
- theme: brand # - theme: brand
text: Markdown Examples # text: Markdown Examples
link: /features/markdown-examples # link: /features/markdown-examples
- theme: alt # - theme: alt
text: API Examples # text: API Examples
link: /features/api-examples # link: /features/api-examples
features: # features:
- title: Feature A # - title: Feature A
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit # details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature B # - title: Feature B
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit # details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- title: Feature C # - title: Feature C
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit # details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
--- ---
# About IronCalc # About IronCalc

View File

@@ -4,7 +4,7 @@ outline: deep
lang: en-US lang: en-US
--- ---
# Python Bindings, a practical guide # JavaScript Bindings
::: warning ::: warning
**Note:** This page is in construction 🚧 **Note:** This page is in construction 🚧

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# Python Bindings
::: warning
**Note:** This page is in construction 🚧
:::

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# Rust
::: warning
**Note:** This page is in construction 🚧
:::

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# About Tironcalc
::: warning
**Note:** This page is in construction 🚧
:::

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# Installing and running Tironcalc
::: warning
**Note:** This page is in construction 🚧
:::

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# Importing Files
::: warning
**Note:** This page is in construction 🚧
:::

View File

@@ -16,5 +16,5 @@ You can upload files using one of the following methods:
- **Click to Upload**: Click on the central upload area and select your file from your device. - **Click to Upload**: Click on the central upload area and select your file from your device.
::: info ::: info
The maximum file size allowed is **1 MB**. The maximum file size allowed is **10 MB**.
::: :::

View File

@@ -0,0 +1,11 @@
---
layout: doc
outline: deep
lang: en-US
---
# Sharing Files
::: warning
**Note:** This page is in construction 🚧
:::