mirror of
https://github.com/zylon-ai/private-gpt.git
synced 2025-12-22 07:40:12 +01:00
feat(docs): update documentation and fix preview-docs (#2000)
Some checks are pending
publish docs / publish-docs (push) Waiting to run
release-please / release-please (push) Waiting to run
tests / setup (push) Waiting to run
tests / ${{ matrix.quality-command }} (black) (push) Blocked by required conditions
tests / ${{ matrix.quality-command }} (mypy) (push) Blocked by required conditions
tests / ${{ matrix.quality-command }} (ruff) (push) Blocked by required conditions
tests / test (push) Blocked by required conditions
tests / all_checks_passed (push) Blocked by required conditions
Some checks are pending
publish docs / publish-docs (push) Waiting to run
release-please / release-please (push) Waiting to run
tests / setup (push) Waiting to run
tests / ${{ matrix.quality-command }} (black) (push) Blocked by required conditions
tests / ${{ matrix.quality-command }} (mypy) (push) Blocked by required conditions
tests / ${{ matrix.quality-command }} (ruff) (push) Blocked by required conditions
tests / test (push) Blocked by required conditions
tests / all_checks_passed (push) Blocked by required conditions
* docs: add missing configurations * docs: change HF embeddings by ollama * docs: add disclaimer about Gradio UI * docs: improve readability in concepts * docs: reorder `Fully Local Setups` * docs: improve setup instructions * docs: prevent have duplicate documentation and use table to show different options * docs: rename privateGpt to PrivateGPT * docs: update ui image * docs: remove useless header * docs: convert to alerts ingestion disclaimers * docs: add UI alternatives * docs: reference UI alternatives in disclaimers * docs: fix table * chore: update doc preview version * chore: add permissions * chore: remove useless line * docs: fixes ...
This commit is contained in:
parent
01b7ccd064
commit
4523a30c8f
13 changed files with 161 additions and 100 deletions
16
.github/workflows/preview-docs.yml
vendored
16
.github/workflows/preview-docs.yml
vendored
|
|
@ -11,13 +11,17 @@ jobs:
|
|||
preview-docs:
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
permissions:
|
||||
contents: read
|
||||
pull-requests: write
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
with:
|
||||
ref: refs/pull/${{ github.event.pull_request.number }}/merge
|
||||
|
||||
- name: Setup Node.js
|
||||
- name: Setup Node.js
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: "18"
|
||||
|
|
@ -37,14 +41,14 @@ jobs:
|
|||
# Set the output for the step
|
||||
echo "::set-output name=preview_url::$preview_url"
|
||||
- name: Comment PR with URL using github-actions bot
|
||||
uses: actions/github-script@v4
|
||||
uses: actions/github-script@v7
|
||||
if: ${{ steps.generate_docs.outputs.preview_url }}
|
||||
with:
|
||||
script: |
|
||||
const preview_url = '${{ steps.generate_docs.outputs.preview_url }}';
|
||||
const issue_number = context.issue.number;
|
||||
github.issues.createComment({
|
||||
...context.repo,
|
||||
issue_number: issue_number,
|
||||
github.rest.issues.createComment({
|
||||
issue_number: context.issue.number,
|
||||
owner: context.repo.owner,
|
||||
repo: context.repo.repo,
|
||||
body: `Published docs preview URL: ${preview_url}`
|
||||
})
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue