Skip to content

Commit

Permalink
📝 Updating documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jossmoff committed Nov 12, 2023
1 parent e06a419 commit 9d9a56d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 9 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ The base command for the `bookshelf` CLI.
| <a href="https://bookshelf.docs.joss.dev/reference/rm/">rm </a> | Remove a story from your bookshelf |
| <a href="https://bookshelf.docs.joss.dev/reference/start/">start </a> | Start a new chapter for a story on your bookshelf |
| <a href="https://bookshelf.docs.joss.dev/reference/stop/">stop </a> | Stop the current chapter of a story on your bookshelf |
| <a href="https://bookshelf.docs.joss.dev/reference/create/">tag </a> | Add a new tag a story on your bookshelf |
| <a href="https://bookshelf.docs.joss.dev/reference/create/">untag </a> | Remove a tag from a story on your bookshelf |

## 🤝 Contributing

Expand Down
2 changes: 2 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ export default defineConfig({
{ label: 'bookshelf rm', link: '/reference/rm/' },
{ label: 'bookshelf start', link: '/reference/start/' },
{ label: 'bookshelf stop', link: '/reference/stop/' },
{ label: 'bookshelf tag', link: '/reference/tag/' },
{ label: 'bookshelf untag', link: '/reference/untag/' },
]
},
],
Expand Down
20 changes: 11 additions & 9 deletions docs/src/content/docs/reference/use-bookshelf-cli.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,15 +14,17 @@ The base command for the `bookshelf` CLI.

### Subcommands

| Name | Description |
| ----------- | ----------- |
| <a href="/reference/create/">create</a> | Create a new story for your bookshelf |
| <a href="/reference/create/">finish </a> | Finish writing a story on your bookshelf |
| <a href="/reference/create/">info </a> | Displays the information for a given story on your bookshelf |
| <a href="/reference/create/">ls </a> | List all the current stories on your bookshelf |
| <a href="/reference/create/">rm </a> | Remove a story from your bookshelf |
| <a href="/reference/create/">start </a> | Start a new chapter for a story on your bookshelf |
| <a href="/reference/create/">stop </a> | Stop the current chapter of a story on your bookshelf |
| Name | Description |
| ----------- | ----------- |
| <a href="/reference/create/">create</a> | Create a new story for your bookshelf |
| <a href="/reference/create/">finish</a> | Finish writing a story on your bookshelf |
| <a href="/reference/create/">info</a> | Displays the information for a given story on your bookshelf |
| <a href="/reference/create/">ls</a> | List all the current stories on your bookshelf |
| <a href="/reference/create/">rm</a> | Remove a story from your bookshelf |
| <a href="/reference/create/">start</a> | Start a new chapter for a story on your bookshelf |
| <a href="/reference/create/">stop</a> | Stop the current chapter of a story on your bookshelf |
| <a href="/reference/create/">tag</a> | Add a new tag a story on your bookshelf |
| <a href="/reference/create/">untag</a> | Remove a tag from a story on your bookshelf |



0 comments on commit 9d9a56d

Please sign in to comment.