Skip to content

Commit 3e4db3b

Browse files
avb-is-meavb-is-me
committed
fixes content
1 parent 205c98d commit 3e4db3b

16 files changed

+540
-1
lines changed

‎docs/editor/Audit your docs.md‎ renamed to ‎docs/Audit your docs.md‎

File renamed without changes.

‎docs/_CodeSnippets.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'My MDX Document'
3+
---
4+
5+
6+
7+
8+
Hey this is coolooo!!!!

‎docs/_Create new docs from existing docs.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
2+
3+
# Create New Docs from Existing Docs
4+
5+
## Step 1: Go to the user-facing docs page
6+
![Documentation Site](/img/create_new_docs_from_existing_docs/step_1.png)
7+
Navigate to your user-facing documentation site. You should see options like "Home", "User-facing docs", "Integrations", etc. in the sidebar. Click on "More with AI" and select "Generate New Docs".
8+
9+
## Step 2: Use AI to Generate a New Page
10+
![Generate New Page](/img/create_new_docs_from_existing_docs/step_3.png)
11+
Click on "More with AI" to open the AI generation options.
12+
13+
## Step 3: Select Document Location
14+
![Select Location](/img/create_new_docs_from_existing_docs/step_4.png)
15+
Choose where you want to create the new document or page. In this example, "docs" is selected.
16+
17+
## Step 4: Choose Context
18+
![Choose Context](/img/create_new_docs_from_existing_docs/step_5.png)
19+
Select which existing docs you want to use as context for the new document. You can choose from available folders.
20+
21+
## Step 5: Add Additional Context
22+
![Add Context](/img/create_new_docs_from_existing_docs/step_6.png)
23+
If needed, add more context by selecting additional folders or files.
24+
25+
## Step 6: Enter Your Prompt
26+
![Enter Prompt](/img/create_new_docs_from_existing_docs/step_9.png)
27+
Type your document prompt in the provided field. For example, you could ask "What are good use cases for Fumadocs?"
28+
29+
## Step 7: Publish the Document
30+
![Publish Document](/img/create_new_docs_from_existing_docs/step_12.png)
31+
Once you're satisfied with the content, add a title and click the "Publish" button to make the new document live.
32+
33+
## Step 8: Confirm Changes
34+
![Confirm Changes](/img/create_new_docs_from_existing_docs/step_13.png)
35+
After publishing, you may see a confirmation or additional options related to the new document.
36+
37+
38+

‎docs/_Generate-Internal-Docs-at-Github-Commit.md‎

Lines changed: 136 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,136 @@
1+
# Generate Internal Docs at Github Commit
2+
3+
## Step 1: Navigate to the Actions tab
4+
5+
On your repo's page click on the "Actions" tab to open the Actions page.
6+
7+
8+
![](/img/generate_internal_docs_at_github_commit/step_1.png)
9+
10+
11+
## Step 2: Click New Workflow Button
12+
13+
On the Actions page, click the "New workflow" button to begin creating a new workflow.
14+
15+
16+
![](/img/generate_internal_docs_at_github_commit/step_2.png)
17+
18+
## Step 3: Click on "set up a workflow yourself" link
19+
20+
On the "Actions" page, click on the "set up a workflow yourself" link to create a new workflow.
21+
22+
23+
![](/img/generate_internal_docs_at_github_commit/step_3.png)
24+
25+
26+
## Step 4: Enter a File Name
27+
28+
In the file name text box, type the name for your file. For example, "gen_docs.yml".
29+
30+
31+
![](/img/generate_internal_docs_at_github_commit/step_6.png)
32+
33+
34+
## Step 5: Copy and paste the this Github actions code
35+
36+
```
37+
38+
name: Gen Internal Docs
39+
on:
40+
push:
41+
branches:
42+
- main
43+
paths:
44+
- '/*.js'
45+
jobs:
46+
dev-docs-app:
47+
runs-on: ubuntu-latest
48+
steps:
49+
- name: Checkout Repository
50+
uses: actions/checkout@v2
51+
- name: Send Update to DevDocs
52+
run: |
53+
TIMESTAMP=$(date -u +"%Y-%m-%dT%H:%M:%SZ")
54+
API_KEY=${{ secrets.API_KEY }}
55+
REPO_GH_PAT=${{secrets.REPO_GH_PAT}}
56+
GITHUB_REPOSITORY="${{ github.repository }}"
57+
GITHUB_ACTOR="${{ github.actor }}"
58+
curl -X POST -H "Content-Type: application/json" \
59+
-H "X-API-KEY: $API_KEY" \
60+
-d '{"apiKey": "'$API_KEY'", "repo_gh_pat": "'$REPO_GH_PAT'", "timestamp": "'$TIMESTAMP'", "githubRepository": "'$GITHUB_REPOSITORY'", "githubActor": "'$GITHUB_ACTOR'"}' \
61+
"${{ secrets.GENERATE_ENDPOINT_URL }}"
62+
env:
63+
API_KEY: ${{ secrets.API_KEY }}
64+
65+
```
66+
67+
![](/img/generate_internal_docs_at_github_commit/step_9.png)
68+
69+
70+
## Step 6: Click on Commit changes button
71+
72+
Click on the "Commit changes..." button to commit the changes.
73+
74+
75+
![](/img/generate_internal_docs_at_github_commit/step_11.png)
76+
77+
## Step 7: Commit changes
78+
79+
Click on the "Commit changes" text link.
80+
81+
82+
![](/img/generate_internal_docs_at_github_commit/step_12.png)
83+
84+
85+
## Step 8: Click on the Settings icon
86+
87+
Click on the gear icon to open the Settings page.
88+
89+
90+
![](/img/generate_internal_docs_at_github_commit/step_14.png)
91+
92+
## Step 9: Click on the Secrets and variables button
93+
94+
Click on the icon button for Secrets and variables to open the menu.
95+
96+
![](/img/generate_internal_docs_at_github_commit/step_15.png)
97+
98+
## Step 10: Click on Actions
99+
100+
Click on the link with the text "Actions".
101+
102+
103+
![](/img/generate_internal_docs_at_github_commit/step_16.png)
104+
105+
106+
![](/img/generate_internal_docs_at_github_commit/step_19.png)
107+
108+
## Step 11: Create New Repository Secrets
109+
110+
Click on the "New repository secret" span to create a new repository secret. `GENERATE_ENDPOINT_URL` is the specific endpoint we need to add for this workflow. Additionally make sure you add the Dev-Docs API-KEY and Github PAT with permissions to read commits, pull requests, and read and write permissions to commits.
111+
112+
113+
114+
[Link to create the Dev-Docs API-Key](/docs/Generating%20an%20API%20Key)
115+
116+
117+
118+
119+
[Link to how to create Github PAT](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token)
120+
121+
122+
![](/img/generate_internal_docs_at_github_commit/step_20.png)
123+
124+
## Step 12: Add GENERATE_ENDPOINT_URL
125+
126+
For the secret name name it `GENERATE_ENDPOINT_URL` and for the value provide your dev-docs base url with the path of `https://api.devdocsapp.com/company/{your org}/generate_internal_docs`
127+
128+
129+
![](/img/generate_internal_docs_at_github_commit/step_22.png)
130+
131+
132+
Finally click the **Add secret** button to open the form to add a new secret.
133+
134+
135+
136+

‎docs/_Generating-an-API-Key.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Generating an API Key
2+
3+
## Step 1: Click on the Avatar Icon
4+
Click on the circular avatar icon to open the profile menu.xzcxzc
5+
6+
7+
![generating_an_api_key/step_2](/img/generating_an_api_key/step_2.png)
8+
9+
## Step 2: Click on Personal API keys
10+
Click on the link that says "Personal API keys".
11+
12+
![generating_an_api_key/step_3](/img/generating_an_api_key/step_3.png)
13+
14+
## Step 3: Click on Replace and Create New API Key button
15+
16+
Click on the "Replace and create new API key" button to generate a new API key.
17+
18+
19+
![generating_an_api_key/step_4](/img/generating_an_api_key/step_4.png)
20+
21+
## Step 5: Replace API Key
22+
On the page https://www.dev-docs.io/personal_api_keys, click on the button with the text "Replace and create new API Key".
23+
24+
25+
![generating_an_api_key/step_5](/img/generating_an_api_key/step_5.png)
26+
27+
Then copy the Dev-Docs API-Key for future use
28+

‎docs/_Integrate-Dev-Docs-with-a-Custom-Docs-Repo.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
2+
3+
# Integrate Dev-Docs with a Custom Docs Repo
4+
5+
## Step 1: Navigate to Dev-Docs Website
6+
7+
On the Dev-Docs website (https://www.dev-docs.io/dash), find the SVG icon with the text " " and click on it.
8+
9+
![This is the image for svg with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_1.png)
10+
11+
## Step 2: Select External Docs Option
12+
13+
Click on the "External" option from the dropdown on the left.
14+
15+
## Step 3: Click on the Settins Icon
16+
17+
On the external docs page (https://www.dev-docs.io/external_docs), find the settings icon and click on it.
18+
19+
![This is the image for path with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_3.png)
20+
21+
## Step 4: Enter Repository Details
22+
23+
Enter the details of your custom docs repository in the input field.
24+
25+
![This is the image for INPUT with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_4.png)
26+
27+
## Step 5: Open Github Integration Modal
28+
29+
Find and click on the DIV containing the text "Setup," "GPT Github Setup," "Live Playground Examples," and other related options.
30+
31+
![This is the image for DIV with the text: SetupGPT Github SetupLive Playground ExamplesPrivate KeyScoped Github PatRepo NamePersonal Access TokenClick to uploadDelete Github IntegrationAdd new File Your current Open API Files. Add to Your DocsRepo NameOwnerDocs PathCreate ChatCreate Example Playground and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_5.png)
32+
33+
## Step 6: Navigate to Your Docs Repo
34+
35+
Go to Github to get both a Personal Access Token as well as the name of your Repo
36+
37+
## Step 7: Click on Profile Picture
38+
39+
On the GitHub repository page (https://github.com/avb-is-me/nextra/tree/main), find the profile picture (IMG) and click on it.
40+
41+
![This is the image for IMG with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_6.png)
42+
43+
## Step 8: Navigate to Settings
44+
45+
Click on the "Settings" option.
46+
47+
![This is the image for SPAN with the text: Settings and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_7.png)
48+
49+
## Step 9: Open Developer Settings
50+
51+
Go to your Github profile settings (https://github.com/settings/profile), find and click on the "Developer settings" option.
52+
53+
54+
## Step 10: Open Personal Access Tokens
55+
56+
On the developer settings page (https://github.com/settings/apps), find and click on the "Personal access tokens" button.
57+
58+
![This is the image for BUTTON with the text: Personal access tokens and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_9.png)
59+
60+
## Step 10: Select Fine-grained Tokens
61+
62+
On the same page, click on the "Fine-grained tokens" option.
63+
64+
![This is the image for SPAN with the text: Fine-grained tokens and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_10.png)
65+
66+
67+
## Step 11: Enter Token Name
68+
69+
On the new personal access token page (https://github.com/settings/personal-access-tokens/new), enter a name for your token in the input field.
70+
71+
![This is the image for INPUT with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_12.png)
72+
73+
## Step 12: Review Token Settings
74+
75+
Review the token settings, including the expiration date, description, resource owner, repository access, and permissions.
76+
77+
![This is the image for DIV with the text: GitHub Apps OAuth Apps Personal access tokens Fine-grained tokens Beta Tokens (classic) and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_13.png)
78+
79+
## Step 13: Select Repository Access Option
80+
81+
Choose the "Only select repositories" option for repository access, and Select your Repo.
82+
83+
![This is the image for INPUT with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_14.png)
84+
85+
86+
## Step 14: Open Repository Permissions Section
87+
88+
Find and click on the DIV containing the text "Repository permissions" to expand the repository permissions section.
89+
90+
![This is the image for DIV with the text: Repository permissions 0 Selected Repository permissions permit access to repositories and related resources. and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_16.png)
91+
92+
93+
## Step 15: Select Read and Write Access for proper Permissions(Pull Requests, Issues, Commits, and Contents)
94+
95+
For the desired permission (e.g., "Commit statuses"), select the "Read and write" access level by clicking on the corresponding label. Recommended Permissions are read & write for "Pull Requests, Issues, Commits, and Contents".
96+
97+
![This is the image for LABEL with the text: Read and write Read and write and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_20.png)
98+
99+
## Step 16: Generate Token
100+
101+
After configuring the desired permissions, click on the "Generate token" button to generate the personal access token.
102+
103+
![This is the image for SPAN with the text: Generate token and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_21.png)
104+
105+
106+
## Step 17: Enter Personal Access Token
107+
108+
On the Dev-Docs external docs page (https://www.dev-docs.io/external_docs), enter the generated personal access token in the input field.
109+
110+
![This is the image for INPUT with the text: and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_23.png)
111+
112+
## Step 18: Upload Integration
113+
114+
Click on the "Click to upload" button to upload the GitHub integration with the provided personal access token.
115+
116+
![This is the image for BUTTON with the text: Click to upload and then clicked](/img/integrate_dev-docs_with_a_custom_docs_repo/step_24.png)
117+
118+
119+
120+

‎docs/_Use the intro feature.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
2+
3+
## Step 1: Locate the Command Palette
4+
5+
Find the relevant command from the command palette to begin using the intro feature.
6+
7+
![image for /img/use_the_intro_feature/step_1](/img/use_the_intro_feature/step_1.png)
8+
9+
## Step 2: Explore the File Structure
10+
11+
Navigate through the file structure in the Explorer view to familiarize yourself with the project layout.
12+
13+
![image for /img/use_the_intro_feature/step_2](/img/use_the_intro_feature/step_2.png)
14+
15+
## Step 3: Examine the Project Files
16+
17+
Review the contents of the project files, including JavaScript, Markdown, and configuration files.
18+
19+
![image for /img/use_the_intro_feature/step_3](/img/use_the_intro_feature/step_3.png)
20+
21+
## Step 4: Analyze the Main JavaScript File
22+
23+
Study the main JavaScript file, which contains important functions and logic for the project.
24+
25+
![image for /img/use_the_intro_feature/step_4](/img/use_the_intro_feature/step_4.png)
26+
27+
28+
29+

0 commit comments

Comments
 (0)