feat: add missing docs (#464)

* feat: add missing docs

* chore: fix gh-deploy command

Author: danigb

README.md

@@ -99,9 +99,7 @@ transpose("A4", "P5");
 
 ## Documentation
 
-Generally, you just need to install `tonal` package (before it was called `@tonaljs/tonal`).
-
-The API documentation is inside README.md of each module 👇
+Visit the [documentation site](https://tonaljs.github.io/tonal/docs) or the README.md of each module 👇
 
 #### Notes and intervals
 

site/content/docs/dictionaries/chord-types.md

@@ -1,6 +1,7 @@
 ---
 title: Chord dictionary
 description: A dictionary of musical chords.
+package: ChordType
 ---
 
 ```js

site/content/docs/dictionaries/scale-types.md

@@ -1,9 +1,9 @@
 ---
 title: Scale dictionary
+description: A dictionary of musical scales.
+package: ScaleType
 ---
 
-A dictionary of musical scales.
-
 ```js
 import { ScaleType } from "tonal";
 ```

site/content/docs/harmony/keys.md

@@ -1,6 +1,7 @@
 ---
 title: Keys
 description: Key scales and chords
+package: Key
 ---
 
 Obtain information of a key's scales and chords:

site/content/docs/harmony/progressions.md

@@ -1,6 +1,7 @@
 ---
 title: Progressions
 description: Parse and create harmonic progressions
+package: Progression
 ---
 
 ```js

site/content/docs/notation/abc-notation.md

@@ -1,6 +1,7 @@
 ---
 title: ABC Notation
 description: Convert note names between scientific and abc notation
+package: AbcNotation
 ---
 
 ```js

site/content/docs/notation/roman-numerals.md

@@ -1,3 +1,51 @@
 ---
 title: Roman Numerals
+description: Functions to parse roman numerals
+package: RomanNumeral
 ---
+
+A roman numeral symbol is a string like `"bVIImaj7"` that can be used to represent chords in an abstract tonality.
+
+```js
+import { RomanNumeral } from "tonal";
+```
+
+## API
+
+### `RomanNumeral.get(src: string | Pitch): => RomanNumeral`
+
+Get the properties of a roman numeral:
+
+Example:
+
+```js
+RomanNumeral.get("bVIIMaj7");
+// =>
+// {
+//   empty: false,
+//   name: "bVIIMaj7",
+//   roman: "VII",
+//   acc: "b",
+//   chordType: "Maj7",
+//   alt: -1,
+//   step: 6,
+//   major: true,
+//   oct: 0
+// }
+```
+
+## FAQ
+
+#### How do I get a roman numeral from an interval
+
+`romanNumeral` function accepts a `Pitch` as argument:
+
+```js
+import { Interval, RomanNumeral } from "tonal";
+
+RomanNumeral.get(Interval.get("3m")).name; // => "bIII"
+```
+
+## Related
+
+Take a look to [@tonal/progression](https://github.com/tonaljs/tonal/tree/master/packages/progression) or [@tonal/key](https://github.com/tonaljs/tonal/tree/master/packages/key)

site/package.json

@@ -8,29 +8,29 @@
     "start": "next start",
     "postinstall": "fumadocs-mdx",
     "deploy": "npm run deploy:build && npm run deploy:fix && npm run deploy:github",
-    "deploy:github": "gh-pages -d out/ -t true",
+    "deploy:github": "gh-pages -d out/ -t",
     "deploy:build": "DEPLOY=true next build",
     "deploy:fix": "cp out/docs.html out/docs/index.html"
   },
   "dependencies": {
     "fumadocs-core": "13.4.10",
     "fumadocs-mdx": "10.0.2",
     "fumadocs-ui": "13.4.10",
-    "gh-pages": "^6.1.1",
+    "gh-pages": "^6.3.0",
     "lucide-react": "^0.441.0",
-    "next": "^14.2.8",
+    "next": "^14.2.24",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
-    "zod": "^3.23.8"
+    "zod": "^3.24.2"
   },
   "devDependencies": {
     "@types/mdx": "^2.0.13",
     "@types/node": "22.5.4",
-    "@types/react": "^18.3.5",
-    "@types/react-dom": "^18.3.0",
+    "@types/react": "^18.3.18",
+    "@types/react-dom": "^18.3.5",
     "autoprefixer": "^10.4.20",
-    "postcss": "^8.4.45",
-    "tailwindcss": "^3.4.10",
-    "typescript": "^5.5.4"
+    "postcss": "^8.5.3",
+    "tailwindcss": "^3.4.17",
+    "typescript": "^5.8.2"
   }
 }