Skip to content

Add docs #7994

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 130 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
130 commits
Select commit Hold shift + click to select a range
71b04dc
feat: initial config
ndom91 Jun 21, 2024
e533897
fix: update repo org files + README
ndom91 Jun 21, 2024
538b86c
fix: update README.md
ndom91 Jun 21, 2024
e0f0fe1
fix: add initial pages
ndom91 Jun 24, 2024
4141418
feat: add initial images
ndom91 Jun 24, 2024
a360955
fix: add images and image wrapper / border
ndom91 Jun 24, 2024
c365aa7
feat: add vercel.json rewrites
ndom91 Jun 24, 2024
32af0a7
fix: typo vercel.json
ndom91 Jun 24, 2024
1e9024c
fix: vercel.json schema
ndom91 Jun 24, 2024
fd3abc8
fix: add more pages
ndom91 Jun 24, 2024
87d0b10
feat: add defaultSeearchDialog
ndom91 Jun 24, 2024
580ba7a
fix: working search
ndom91 Jun 24, 2024
01a9ec8
fix: tweak font and design
ndom91 Jun 24, 2024
5e33e71
feat: add more docs pages
ndom91 Jun 24, 2024
63c72be
feat: add some illustrations
ndom91 Jun 24, 2024
96f8602
fix: cleanup system-ui font and OG meta
ndom91 Jun 25, 2024
c60f8de
feat: add the rest of the remaining content
ndom91 Jun 25, 2024
72ce478
feat: add manifest and sitemap and og/twitter banners
ndom91 Jun 25, 2024
56c77d8
fix: update .gitignore
ndom91 Jun 25, 2024
0b2bdd7
fix: cleanup config
ndom91 Jun 25, 2024
88751bd
fix: manifest filename typos
ndom91 Jun 25, 2024
9419640
feat: add TOC micro interactions and roll btn
ndom91 Jun 25, 2024
a691f6e
fix: rename pages / paths to match old ones and add redirects where n…
ndom91 Jun 25, 2024
defb6fc
feat: add .github repo orga items and broken-link-checker GHA
ndom91 Jun 25, 2024
34421e5
fix: cleanup pages and use fuma components where appropriate
ndom91 Jun 25, 2024
b9600f6
fix: use tabs in more places
ndom91 Jun 25, 2024
f421d8b
feat: add CodeEditor wrapper
ndom91 Jun 25, 2024
1116695
fix: polish micro interactions
ndom91 Jun 25, 2024
6241112
fix: cleanup styling
ndom91 Jun 25, 2024
a1ad2c6
feat: add Inter for default body font
ndom91 Jun 26, 2024
92595ce
fix: discord icon
ndom91 Jun 26, 2024
b93e833
Merge branch 'main' of github.com:ndom91/gitbutler-docs
ndom91 Jun 26, 2024
4673dd4
fix: update README and minor content tweaks
ndom91 Jun 26, 2024
509b9ce
feat: add scribble-bowtie.svg
ndom91 Jun 26, 2024
b8cd2c8
chore: update README.md
ndom91 Jun 26, 2024
6e09242
chore: add sharp-bowtie.svg
ndom91 Jun 26, 2024
27ce1fa
Merge branch 'main' of github.com:ndom91/gitbutler-docs
ndom91 Jun 26, 2024
0a3fa64
chore: update README.md
ndom91 Jun 26, 2024
45b1a59
fix: ImageSection CSS tweaks
ndom91 Jun 27, 2024
32d1f6e
fix: rm CodeEditor chrome
ndom91 Jun 28, 2024
d6272a3
fix: edit on github URL
ndom91 Jun 28, 2024
7f8d1ac
fix: rm full width from supporters and manifesto page (#1)
ndom91 Jul 2, 2024
167e005
fix: gitbutler repo URLs (#2)
ndom91 Jul 2, 2024
6784909
fix: add link to integration docs (#3)
eltigerchino Jul 8, 2024
7f22108
fix: update README link (#4)
ndom91 Jul 8, 2024
eb630ac
fix: add CODEOWNERS file (#5)
ndom91 Jul 8, 2024
da18244
fix: update README links (#6)
ndom91 Jul 8, 2024
d57d6d6
fix: cleanup path to releases page (#7)
ndom91 Jul 9, 2024
9834e88
feat: add new release placehodler (#9)
ndom91 Jul 12, 2024
96e107e
fix(gha): update markdown comment placeholder release string (#10)
ndom91 Jul 13, 2024
a9e8c24
fix: add broken-link-checker debug output + bump eslint config (#11)
ndom91 Jul 13, 2024
56a9ebb
fix: cleanup broken-link-checker (#12)
ndom91 Jul 13, 2024
998ea25
fix: show external links hostname is broken-link-checker (#13)
ndom91 Jul 13, 2024
593a0d9
fix: dummy (#14)
ndom91 Jul 13, 2024
1b27980
fix: manually bump releases.mdx page for now (#16)
ndom91 Jul 27, 2024
ecdddc8
fix: add info about AI commit msg variables (#19)
ndom91 Jul 27, 2024
9632ad1
Fix typo in comitter-mark.mdx (#20)
blyme Jul 28, 2024
2220885
feat: add OpenAPI v3 visualisation to docs (#17)
ndom91 Jul 29, 2024
720af11
fix: whitelist 'Edit on GitHub' links for broken-link-checker (#21)
ndom91 Jul 29, 2024
8db3857
fix: remove unnecessary title adjustment (#23)
ndom91 Jul 31, 2024
68847eb
fix: remove debugging output (#24)
ndom91 Jul 31, 2024
90878f1
clarify docs (#25)
krlvi Aug 16, 2024
a30bbbe
oplog format is a little different (#22)
schacon Sep 2, 2024
40d031b
feat: Add getting started guide and overview
schacon Aug 29, 2024
779b401
feat(getting-started): Add detailed guide with screenshots
schacon Sep 2, 2024
d07992e
move why gitbutler under getting started
schacon Sep 2, 2024
d7b42b5
fix: move getting-started/* pages to top-level
ndom91 Sep 2, 2024
715d61d
fix: add vercel redirect from old path
ndom91 Sep 2, 2024
f6e516f
fix: rename Welcome title
ndom91 Sep 2, 2024
0aa5c3c
fix: old links
ndom91 Sep 2, 2024
09cca57
add oss pledge json
schacon Sep 2, 2024
ed97c17
update oss pledge to be last year (#29)
schacon Sep 2, 2024
6f4a42a
a page for our OS stuff (#31)
schacon Sep 2, 2024
67aa34f
boom (#32)
schacon Sep 2, 2024
282c3f1
fix: bump all dependencies and clean up (#30)
ndom91 Sep 3, 2024
9f74742
fix: rm unnecessary h-fit (#34)
ndom91 Sep 30, 2024
40950c4
feat: add remarkMermaid plugin (#35)
ndom91 Oct 7, 2024
25d0dfb
fix: grammar (#38)
mhdadk Oct 12, 2024
5bb6896
feat: add note about new `branch_name` token (#39)
ndom91 Oct 18, 2024
49c277c
Fix path to logs
koppor Oct 11, 2024
ed1e855
add fearless rebasing and rename trunk/base to target
schacon Oct 23, 2024
1cb1149
fix: link to tauri docs app log dir (#41)
ndom91 Oct 24, 2024
6b99644
feat: add note about new branch_name token (#42)
ndom91 Nov 1, 2024
bd3a012
fix: typo in releases.mdx page (#43)
ndom91 Nov 2, 2024
fc51ba3
feat: bump fumadocs and Next.js (#44)
ndom91 Nov 12, 2024
3fab867
docs: add section on GitHub OAuth app access troubleshooting.
taylorsabbag Nov 14, 2024
5bdfbb5
Add documentation for Stacked branches
krlvi Nov 22, 2024
89818f7
fix: workaround for cyclic refs in openapi definition
ndom91 Nov 23, 2024
85ccfab
Add screenshots
krlvi Nov 25, 2024
944b56d
Add more screenshots
krlvi Nov 25, 2024
d2566b4
Describe mitigation strategies for common stack issues
krlvi Nov 25, 2024
b24a124
modify image section
PavelLaptev Nov 26, 2024
2aa1666
replace `alt` with `subtitle`
PavelLaptev Nov 26, 2024
5667d1e
update image caption font-size
PavelLaptev Nov 26, 2024
1d58af8
update images
PavelLaptev Nov 26, 2024
5861e57
Update ImageSection.tsx
PavelLaptev Nov 26, 2024
040590a
remove unused image attributes
PavelLaptev Nov 26, 2024
1ed1c1d
Update ImageSection.tsx
PavelLaptev Nov 26, 2024
d9d19d7
remove PP Editorial font
PavelLaptev Nov 26, 2024
e47cda6
Fixed a few typos in docs
krlvi Nov 26, 2024
96afc00
Clarified part of the stacking workflow
krlvi Nov 26, 2024
5da8036
Fix some grammar in stacked branches page
mtsgrd Nov 26, 2024
b116a23
feat: static import of img source (#52)
ndom91 Nov 26, 2024
a6d1b87
Fix incorrect screenshots
krlvi Nov 26, 2024
b2cc131
Add a sentence explaining why merge strategy can be better UX
krlvi Nov 26, 2024
5072a5f
Integrate umami
krlvi Nov 26, 2024
d10e933
fix: bump fumadocs-openapi and rm workaround for cyclic references (#56)
ndom91 Nov 27, 2024
19c0ff4
fix: hide API Reference from sidebar (#57)
ndom91 Nov 27, 2024
a22656e
feat: add 404 page (#58)
ndom91 Nov 27, 2024
f8dc9df
Fix typo (#59)
boc-the-git Nov 29, 2024
640b28f
Update debugging.mdx (#60)
niklaswimmer Nov 29, 2024
d3e37ed
fix(docs): update video link in latest features section
krlvi Dec 4, 2024
48aa92d
Provide alternative log location for linux
Byron Dec 5, 2024
cdaaace
Update branch-lanes.mdx (#64)
kikocastro Dec 27, 2024
b28d3b0
fix: update branch name from integration to workspace (#65)
polisherm Dec 29, 2024
9cd0549
feat: add llms.txt (#66)
ndom91 Jan 7, 2025
7bed595
fix: update references to integration branch and gitbutler binary in …
ndom91 Jan 10, 2025
fad1339
fix: add notes about Linux debugging
ndom91 Jan 10, 2025
a60d273
fix: update PR template
ndom91 Jan 10, 2025
138cbdf
add docs to descriptions
schacon Jan 20, 2025
5311f73
docs: fix grammar
ahamez Feb 25, 2025
a564142
small copy updates
schacon Feb 27, 2025
8ed2dbf
add butler review docs
schacon Feb 27, 2025
57532f7
Updated fumadocs (#75)
Caleb-T-Owens Mar 25, 2025
56ddfa8
Add baseUrl (#76)
Caleb-T-Owens Mar 25, 2025
9eda329
Disabling the API docs (#77)
Caleb-T-Owens Mar 25, 2025
5ea9ae4
Add nvmrc and gitlab integration
Caleb-T-Owens Mar 25, 2025
50b0b0a
Add GitLab integration
Caleb-T-Owens Mar 25, 2025
279f228
Moved docs into docs folder
Caleb-T-Owens Apr 4, 2025
65b1fef
Merge commit '279f2282d' into add-docs
Caleb-T-Owens Apr 4, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions apps/docs/.github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @ndom91
22 changes: 22 additions & 0 deletions apps/docs/.github/ISSUE_TEMPLATE/1_documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: "Documentation"
description: Request to update or improve GitButler documentation
labels: ["triage", "documentation"]
body:
- type: textarea
attributes:
label: What is the improvement or update you wish to see?
description: "Example: The GitButler docs are missing information about X."
validations:
required: true
- type: textarea
attributes:
label: Is there any context that might help us understand?
description: A clear description of any added context that might help us understand.
validations:
required: false
- type: input
attributes:
label: Does the docs page already exist? Please link to it.
description: "Example: https://docs.gitbutler.com/features/virtual-branches"
validations:
required: false
5 changes: 5 additions & 0 deletions apps/docs/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Get help from the community (Discord)
url: https://discord.com/invite/MmFkmaJ42D
about: Ask questions and discuss with other community members
22 changes: 22 additions & 0 deletions apps/docs/.github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 🧢 Changes


## ☕️ Reasoning


<!--
If this PR is related to a specific issue, uncomment this section
and link it via the following text:

## 🎫 Affected issues

Fixes: INSERT_ISSUE_NUMBER

-->

<!--
If this is a WIP PR and you have todos left, feel free to uncomment this and turn this PR into a draft, see https://github.blog/2019-02-14-introducing-draft-pull-requests/

## 📌 Todos

-->
8 changes: 8 additions & 0 deletions apps/docs/.github/broken-link-checker/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
name: "Broken Link Checker"
description: "Recursively checks input URL for broken links"
outputs:
version:
description: "Check for broken internal links"
runs:
using: "node20"
main: "dist/index.js"
16 changes: 16 additions & 0 deletions apps/docs/.github/broken-link-checker/dist/index.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions apps/docs/.github/broken-link-checker/index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
declare module "broken-link-checker";
31 changes: 31 additions & 0 deletions apps/docs/.github/broken-link-checker/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"name": "broken-link-checker",
"private": true,
"version": "0.2.0",
"description": "Find broken links as a GitHub Action",
"main": "dist/index.js",
"type": "module",
"scripts": {
"dev": "tsx src/index.ts",
"build": "npx tsup --clean --minify --format esm src/index.ts",
"types": "tsc"
},
"keywords": [
"typescript",
"broken-link-checker",
"github-action"
],
"author": "ndom91 <[email protected]> (https://ndo.dev/)",
"license": "MIT",
"devDependencies": {
"@types/node": "^20.11.15",
"tsup": "^8.0.1",
"tsx": "^4.7.0",
"typescript": "^5.3.3"
},
"dependencies": {
"@actions/core": "^1.10.1",
"@actions/github": "^6.0.0",
"broken-link-checker": "^0.7.8"
}
}
Loading
Loading