docs: A new "Using Ask Fern" section was added between the "Setup" and "Configuration" sections, which explains the three different ways users can interact with the bot: using the /fern command, mentioning the bot with @Ask Fern, or asking questions naturally in configured channels. This addition provides clearer guidance on how to actually use the bot after installation.
#1461
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Preview Docs | |
| on: | |
| pull_request_target: | |
| types: [opened, synchronize, ready_for_review] | |
| branches: | |
| - main | |
| jobs: | |
| run: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| pull-requests: write # Only for commenting | |
| contents: read # For checking out code | |
| steps: | |
| - name: Checkout repository | |
| uses: actions/checkout@v4 | |
| - name: Checkout PR | |
| if: github.event_name == 'pull_request_target' | |
| run: | | |
| git fetch origin pull/${{ github.event.pull_request.number }}/head:pr-${{ github.event.pull_request.number }} | |
| git checkout pr-${{ github.event.pull_request.number }} | |
| - name: Install Fern | |
| run: npm install -g fern-api | |
| - name: Generate preview URL | |
| id: generate-docs | |
| env: | |
| FERN_TOKEN: ${{ secrets.FERN_TOKEN }} | |
| run: | | |
| OUTPUT=$(fern generate --docs --preview --instance fern-api.docs.buildwithfern.com/learn 2>&1) || true | |
| echo "$OUTPUT" | |
| URL=$(echo "$OUTPUT" | grep -oP 'Published docs to \K.*(?= \()') | |
| echo "Preview URL: $URL" | |
| echo "🌿 Preview your docs: $URL" > preview_url.txt | |
| - name: Comment URL in PR | |
| uses: thollander/[email protected] | |
| with: | |
| filePath: preview_url.txt |