Skip to content

Commit d18883d

Browse files
committed
simplify docs structure
1 parent 1991c96 commit d18883d

22 files changed

+12
-32
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,8 @@ jobs:
6060
6161
- name: Cut a docs file for the new release
6262
run: |
63-
cat docs/src/@next.md | sed 's/@version@/${{ steps.package-version.outputs.current-version }}/gi' > docs/src/${{ steps.package-version.outputs.current-version }}.md
64-
git add docs/src/${{ steps.package-version.outputs.current-version }}.md
63+
cat docs/@next.md | sed 's/@version@/${{ steps.package-version.outputs.current-version }}/gi' > docs/${{ steps.package-version.outputs.current-version }}.md
64+
git add docs/${{ steps.package-version.outputs.current-version }}.md
6565
cat docs/readme.md | sed 's/\<\!--new_docs_links_here--\>/\<\!--new_docs_links_here--\>\n\n- \[\v${{ steps.package-version.outputs.current-version }}]\(${{ steps.package-version.outputs.current-version }}.md\)/g' > docs/readme.md
6666
git add docs/readme.md
6767
git commit -m"New doc file ${{ steps.package-version.outputs.current-version }}.md"
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/src/@next.md renamed to docs/@next.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -896,6 +896,15 @@ One of the [Caching Hooks](#caching-hooks) functions. The framework will call th
896896

897897
Resource CFCs extend `taffy.core.resource`. The following methods are available inside each of your Resource CFCs:
898898

899+
#### addDebugData()
900+
901+
**Use it inside:** responder methods inside your Resource CFCs (e.g. get, put, post, delete)<br/>
902+
**Parameters:**
903+
904+
- **data (any)** - data to include in exception logs.
905+
906+
This method saves data in a way that makes it available to [exception log adapters](https://github.com/atuttle/Taffy/wiki/Exception-Logging-Adapters), if and when exceptions occur. It's a handy way to help you understand what was going on when an exception happened.
907+
899908
#### encode.string()
900909

901910
**Use it inside:** responder methods inside your Resource CFCs (e.g. get, put, post, delete)<br/>
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/src/index.html renamed to docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<script>
3838
window.$docsify = {
3939
name: "Taffy Docs",
40-
repo: "atuttle/TaffyDocs",
40+
repo: "atuttle/Taffy",
4141
maxLevel: 4,
4242
};
4343
</script>
File renamed without changes.

docs/src/README.md

Lines changed: 0 additions & 29 deletions
This file was deleted.

0 commit comments

Comments
 (0)