feat: Initial docs structure (#380)

* feat: Initial docs structure

* cr
This commit is contained in:
Brace Sproul 2025-07-10 12:48:59 -07:00 • committed by GitHub
parent 69893e4875
commit 5ec76feee1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
17 changed files with 4390 additions and 77 deletions

16
apps/docs/README.md Normal file
View file

@ -0,0 +1,16 @@
# Open Agent Platform Docs
The OAP docs are built with Mintlify. To preview the docs locally, run the following command:
```bash
npx mintlify dev
```
Or install mint globally:
```bash
npm i -g mintlify
mintlify dev
```
This will start a local development server at http://localhost:3000. You can now view and edit your docs in real-time.

6
apps/docs/concepts.mdx Normal file
View file

@ -0,0 +1,6 @@
---
title: 'Concepts'
description: 'Conceptual Guide to the Open SWE agents'
---
(do NOT implement this page. i will do this later)

75
apps/docs/docs.json Normal file
View file

@ -0,0 +1,75 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Open SWE",
"colors": {
"primary": "#0ea5e9",
"light": "#38bdf8",
"dark": "#0369a1"
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
"tab": "Guides",
"groups": [
{
"group": "Get Started",
"pages": [
"index",
"concepts"
]
},
{
"group": "Usage",
"pages": [
"usage/index",
"usage/ui",
"usage/webhook"
]
},
{
"group": "Development Setup",
"pages": [
"setup/index",
"setup/development",
"setup/authentication"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "Demo",
"href": "https://openswe.langchain.com",
"icon": "link"
},
{
"anchor": "GitHub",
"href": "https://github.com/langchain-ai/open-swe",
"icon": "github"
}
]
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "GitHub",
"href": "https://github.com/langchain-ai/open-swe"
}
]
},
"footer": {
"socials": {
"github": "https://github.com/langchain-ai/open-swe",
"twitter": "https://twitter.com/langchainai"
}
}
}

3
apps/docs/favicon.svg Normal file

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 5.7 KiB

30
apps/docs/index.mdx Normal file
View file

@ -0,0 +1,30 @@
---
title: 'Introduction'
description: 'An introduction to Open SWE'
---
<CardGroup cols={2}>
<Card
title="Concepts"
icon="bolt"
href="/concepts"
>
Concepts
</Card>
<Card
title="Setup"
icon="robot"
href="/setup"
>
How to set up Open SWE for development
</Card>
<Card
title="Usage"
icon="database"
href="/usage"
>
Open SWE features, and how to use them
</Card>
</CardGroup>
(add a very high level overview of what open swe is, and what content the docs cover)

20
apps/docs/logo/dark.svg Normal file
View file

@ -0,0 +1,20 @@
<svg width="2018" height="196" viewBox="0 0 2018 196" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M259.955 0.229248C308.707 0.229248 348.367 40.0285 348.367 88.948C348.367 137.867 308.707 177.667 259.955 177.667H88.8623C40.1103 177.667 0.450287 137.867 0.450195 88.948C0.450195 40.0285 40.1102 0.229327 88.8623 0.229248H259.955ZM252.577 117.12C249.963 116.795 247.308 117.087 244.827 117.972C242.347 118.858 240.109 120.312 238.295 122.218C236.481 124.123 235.14 126.428 234.382 128.945C233.624 131.462 233.468 134.122 233.929 136.71C234.389 139.297 235.453 141.742 237.033 143.844C238.613 145.947 240.667 147.651 243.027 148.817C245.388 149.984 247.991 150.581 250.626 150.56C254.22 150.532 257.712 149.358 260.588 147.207C263.464 145.056 265.575 142.042 266.609 138.607C267.644 135.173 267.549 131.498 266.338 128.122C265.127 124.745 262.864 121.844 259.88 119.844C257.693 118.378 255.191 117.445 252.577 117.12ZM105.583 37.532C98.2339 26.6548 75.0286 23.685 71.626 39.0525C71.6398 39.5264 71.4865 39.8327 71.0684 40.1394C69.1858 41.52 67.512 43.0827 66.1035 44.9792C62.6594 49.7904 62.1299 57.9484 66.4248 62.2712C66.5782 59.9844 66.6477 57.8364 68.4463 56.2048C71.7651 59.0635 76.7996 60.0814 80.6484 57.948C89.1549 70.1499 87.0355 87.0233 93.7988 100.174C95.6675 103.283 97.5507 106.463 99.9492 109.182C101.902 112.208 108.623 115.792 109.014 118.609C109.083 123.434 108.525 128.706 111.677 132.75C113.168 135.776 109.516 138.815 106.573 138.439C102.752 138.969 98.0939 135.859 94.7471 137.769C93.5619 139.052 91.2476 137.631 90.2295 139.415C89.8669 140.335 87.9561 141.633 89.0996 142.525C90.3686 141.563 91.5399 140.559 93.2412 141.131C92.9903 142.525 94.0915 142.72 94.9561 143.125C94.9281 144.059 94.3709 145.021 95.0957 145.83C95.9324 144.979 96.4347 143.766 97.7734 143.418C102.222 149.358 106.741 137.407 116.349 142.79C114.396 142.692 112.653 142.929 111.342 144.547C111.021 144.909 110.743 145.328 111.314 145.802C116.502 142.442 116.474 146.946 119.835 145.565C122.429 144.213 124.994 142.511 128.076 142.999C125.078 143.863 124.966 146.276 123.209 148.312C122.902 148.619 122.763 148.982 123.111 149.498C129.317 148.982 129.82 146.904 134.84 144.366C138.577 142.065 142.315 147.629 145.55 144.464C146.275 143.78 147.25 144.017 148.129 143.92C146.999 137.867 134.561 145.021 134.756 136.905C138.758 134.172 137.838 128.943 138.103 124.718C142.704 127.283 147.823 128.761 152.341 131.216C154.628 134.897 158.198 139.778 162.953 139.457C163.079 139.081 163.19 138.76 163.329 138.384C164.765 138.635 166.62 139.582 167.415 137.756C169.563 140.015 172.743 139.904 175.56 139.318L175.587 139.332C177.679 137.63 171.668 135.204 170.859 133.461C172.254 131.759 165.812 126.99 164.501 125.233C161.824 122.319 161.81 118.135 160.011 114.732C155.59 104.469 150.528 94.2891 143.43 85.6013C135.927 76.1047 126.682 68.2391 118.552 59.3142C112.528 53.0947 110.91 44.2256 105.583 37.532ZM222.09 69.3796C220.314 68.7382 218.442 68.4 216.554 68.3787C212.105 68.3787 207.838 70.1367 204.691 73.2664C201.545 76.3963 199.777 80.6418 199.777 85.0681C199.777 89.4945 201.545 93.7399 204.691 96.8699C207.838 99.9997 212.104 101.758 216.554 101.759C218.443 101.737 220.314 101.398 222.09 100.757L231.779 115.11L238.741 110.437L229.137 96.0837C230.86 94.1149 232.095 91.7711 232.743 89.241H258.496V80.8962H232.743C232.095 78.3662 230.86 76.0222 229.137 74.0535L238.825 59.7L231.779 55.0261L222.09 69.3796ZM262.701 59.9333L272.395 74.0837C269.757 77.1238 268.292 81.021 268.292 85.0681C268.292 89.5195 270.066 93.7886 273.221 96.9363C276.376 100.084 280.656 101.853 285.118 101.853C289.581 101.853 293.86 100.084 297.016 96.9363C300.171 93.7886 301.943 89.5195 301.943 85.0681C301.943 80.6165 300.171 76.3468 297.016 73.199C293.86 70.0512 289.581 68.283 285.118 68.283C283.028 68.283 280.978 68.6703 279.065 69.406L269.422 55.3289L262.701 59.9333ZM252.577 19.6511C249.963 19.326 247.308 19.6182 244.827 20.5037C242.347 21.3891 240.109 22.843 238.295 24.7488C236.481 26.6546 235.14 28.9592 234.382 31.4763C233.624 33.9933 233.468 36.6532 233.929 39.241C234.389 41.8287 235.453 44.2728 237.033 46.3757C238.613 48.4785 240.667 50.1819 243.027 51.3484C245.388 52.5149 247.991 53.1128 250.626 53.0925C254.22 53.0647 257.712 51.8889 260.588 49.738C263.464 47.587 265.575 44.5728 266.609 41.1384C267.644 37.7042 267.549 34.0294 266.338 30.6531C265.127 27.2767 262.863 24.3758 259.88 22.3757C257.693 20.9099 255.191 19.9763 252.577 19.6511Z" fill="white"/>
<path d="M1997.15 152.188V96.4283C1997.15 90.1383 1995.59 85.2366 1992.47 81.7233C1989.35 78.1533 1985.13 76.3683 1979.81 76.3683C1976.52 76.3683 1973.57 77.1333 1970.97 78.6633C1968.36 80.1366 1966.29 82.3466 1964.76 85.2933C1963.23 88.1833 1962.47 91.6399 1962.47 95.6633L1953.37 90.3083C1953.31 83.9616 1954.73 78.3799 1957.62 73.5633C1960.57 68.6899 1964.53 64.8933 1969.52 62.1733C1974.51 59.4533 1980.06 58.0933 1986.18 58.0933C1996.32 58.0933 2004.09 61.1533 2009.47 67.2733C2014.91 73.3366 2017.63 81.3266 2017.63 91.2433V152.188H1997.15ZM1886.73 152.188V60.3883H1904.84V88.8633H1907.39V152.188H1886.73ZM1942.07 152.188V96.6833C1942.07 90.2799 1940.51 85.2933 1937.39 81.7233C1934.27 78.1533 1930.02 76.3683 1924.64 76.3683C1919.43 76.3683 1915.23 78.1533 1912.06 81.7233C1908.94 85.2933 1907.39 89.9399 1907.39 95.6633L1898.21 89.5433C1898.21 83.5933 1899.68 78.2383 1902.63 73.4783C1905.57 68.7183 1909.54 64.9783 1914.53 62.2583C1919.57 59.4816 1925.21 58.0933 1931.44 58.0933C1938.3 58.0933 1944.02 59.5666 1948.61 62.5133C1953.26 65.4033 1956.71 69.3699 1958.98 74.4133C1961.3 79.3999 1962.47 85.0383 1962.47 91.3283V152.188H1942.07Z" fill="white"/>
<path d="M1825.8 152.188V60.3881H1843.91V82.7432L1841.7 79.8532C1842.83 76.7932 1844.33 74.0165 1846.2 71.5231C1848.13 68.9731 1850.42 66.8765 1853.09 65.2332C1855.35 63.7031 1857.85 62.5132 1860.57 61.6632C1863.34 60.7565 1866.18 60.2181 1869.07 60.0481C1871.96 59.8215 1874.76 59.9348 1877.48 60.3881V79.5131C1874.76 78.7198 1871.62 78.4648 1868.05 78.7481C1864.53 79.0315 1861.36 80.0231 1858.53 81.7231C1855.69 83.2531 1853.37 85.2081 1851.56 87.5881C1849.8 89.9681 1848.5 92.6881 1847.65 95.7481C1846.8 98.7515 1846.37 102.01 1846.37 105.523V152.188H1825.8Z" fill="white"/>
<path d="M1768.06 154.738C1758.88 154.738 1750.86 152.67 1744 148.533C1737.15 144.396 1731.82 138.701 1728.02 131.448C1724.28 124.138 1722.41 115.751 1722.41 106.288C1722.41 96.6548 1724.34 88.2115 1728.19 80.9581C1732.05 73.7048 1737.4 68.0381 1744.26 63.9581C1751.11 59.8781 1759.05 57.8381 1768.06 57.8381C1777.29 57.8381 1785.34 59.9065 1792.2 64.0431C1799.05 68.1798 1804.38 73.9031 1808.18 81.2131C1811.97 88.4665 1813.87 96.8248 1813.87 106.288C1813.87 115.808 1811.95 124.223 1808.09 131.533C1804.3 138.786 1798.97 144.481 1792.11 148.618C1785.26 152.698 1777.24 154.738 1768.06 154.738ZM1768.06 135.528C1776.22 135.528 1782.28 132.808 1786.25 127.368C1790.21 121.928 1792.2 114.901 1792.2 106.288C1792.2 97.3915 1790.19 90.3081 1786.16 85.0381C1782.14 79.7115 1776.1 77.0481 1768.06 77.0481C1762.56 77.0481 1758.03 78.2948 1754.46 80.7881C1750.94 83.2248 1748.34 86.6531 1746.64 91.0731C1744.94 95.4365 1744.09 100.508 1744.09 106.288C1744.09 115.185 1746.1 122.296 1750.12 127.623C1754.2 132.893 1760.18 135.528 1768.06 135.528Z" fill="white"/>
<path d="M1681.38 152.188V58.9433C1681.38 56.6199 1681.46 54.0699 1681.63 51.2933C1681.8 48.4599 1682.28 45.6549 1683.08 42.8783C1683.87 40.1016 1685.31 37.5799 1687.41 35.3133C1690.02 32.4233 1692.82 30.4399 1695.83 29.3633C1698.89 28.2299 1701.89 27.6066 1704.84 27.4933C1707.78 27.3233 1710.36 27.2383 1712.57 27.2383H1724.05V43.8983H1713.42C1709.51 43.8983 1706.59 44.8899 1704.67 46.8733C1702.8 48.7999 1701.86 51.3499 1701.86 54.5233V152.188H1681.38ZM1666.59 76.4533V60.3883H1724.05V76.4533H1666.59Z" fill="white"/>
<path d="M1660.45 152.188C1654.38 153.322 1648.43 153.803 1642.6 153.633C1636.82 153.52 1631.63 152.472 1627.04 150.488C1622.45 148.448 1618.97 145.247 1616.59 140.883C1614.49 136.917 1613.38 132.865 1613.27 128.728C1613.16 124.592 1613.1 119.917 1613.1 114.703V34.8882H1633.5V113.513C1633.5 117.197 1633.53 120.427 1633.59 123.203C1633.7 125.98 1634.29 128.247 1635.37 130.003C1637.41 133.403 1640.67 135.302 1645.15 135.698C1649.62 136.095 1654.72 135.868 1660.45 135.018V152.188ZM1596.44 76.4532V60.3882H1660.45V76.4532H1596.44Z" fill="white"/>
<path d="M1541.16 154.738C1534.53 154.738 1528.92 153.491 1524.33 150.998C1519.74 148.448 1516.26 145.076 1513.88 140.883C1511.55 136.69 1510.39 132.071 1510.39 127.028C1510.39 122.608 1511.13 118.641 1512.6 115.128C1514.07 111.558 1516.34 108.498 1519.4 105.948C1522.46 103.341 1526.43 101.216 1531.3 99.5731C1534.98 98.3831 1539.29 97.3065 1544.22 96.3431C1549.21 95.3798 1554.59 94.5015 1560.37 93.7081C1566.21 92.8581 1572.3 91.9515 1578.65 90.9881L1571.34 95.1531C1571.39 88.8065 1569.98 84.1315 1567.09 81.1281C1564.2 78.1248 1559.32 76.6231 1552.47 76.6231C1548.33 76.6231 1544.33 77.5865 1540.48 79.5131C1536.63 81.4398 1533.94 84.7548 1532.41 89.4581L1513.71 83.5931C1515.97 75.8298 1520.28 69.5965 1526.63 64.8931C1533.03 60.1898 1541.64 57.8381 1552.47 57.8381C1560.63 57.8381 1567.79 59.1698 1573.97 61.8331C1580.2 64.4965 1584.82 68.8598 1587.83 74.9231C1589.47 78.1531 1590.46 81.4681 1590.8 84.8681C1591.14 88.2115 1591.31 91.8665 1591.31 95.8331V152.188H1573.38V132.298L1576.35 135.528C1572.21 142.158 1567.37 147.031 1561.82 150.148C1556.32 153.208 1549.43 154.738 1541.16 154.738ZM1545.24 138.418C1549.89 138.418 1553.85 137.596 1557.14 135.953C1560.43 134.31 1563.03 132.298 1564.96 129.918C1566.94 127.538 1568.28 125.3 1568.96 123.203C1570.03 120.596 1570.63 117.621 1570.74 114.278C1570.91 110.878 1571 108.13 1571 106.033L1577.29 107.903C1571.11 108.866 1565.81 109.716 1561.39 110.453C1556.97 111.19 1553.17 111.898 1550 112.578C1546.83 113.201 1544.02 113.91 1541.59 114.703C1539.21 115.553 1537.19 116.545 1535.55 117.678C1533.91 118.811 1532.63 120.115 1531.73 121.588C1530.88 123.061 1530.45 124.79 1530.45 126.773C1530.45 129.04 1531.02 131.051 1532.15 132.808C1533.28 134.508 1534.93 135.868 1537.08 136.888C1539.29 137.908 1542.01 138.418 1545.24 138.418Z" fill="white"/>
<path d="M1476.34 152.188V27.2383H1496.83V152.188H1476.34Z" fill="white"/>
<path d="M1372.87 152.188V29.7883H1423.45C1424.64 29.7883 1426.17 29.845 1428.04 29.9583C1429.91 30.015 1431.63 30.185 1433.22 30.4683C1440.3 31.545 1446.14 33.8967 1450.73 37.5233C1455.38 41.15 1458.81 45.74 1461.02 51.2933C1463.28 56.79 1464.42 62.91 1464.42 69.6533C1464.42 76.34 1463.28 82.46 1461.02 88.0133C1458.75 93.51 1455.29 98.0717 1450.65 101.698C1446.06 105.325 1440.25 107.677 1433.22 108.753C1431.63 108.98 1429.88 109.15 1427.95 109.263C1426.08 109.377 1424.58 109.433 1423.45 109.433H1393.36V152.188H1372.87ZM1393.36 90.3083H1422.6C1423.73 90.3083 1425 90.2517 1426.42 90.1383C1427.84 90.025 1429.14 89.7983 1430.33 89.4583C1433.73 88.6083 1436.39 87.1067 1438.32 84.9533C1440.3 82.8 1441.69 80.3633 1442.49 77.6433C1443.34 74.9233 1443.76 72.26 1443.76 69.6533C1443.76 67.0467 1443.34 64.3833 1442.49 61.6633C1441.69 58.8867 1440.3 56.4217 1438.32 54.2683C1436.39 52.115 1433.73 50.6133 1430.33 49.7633C1429.14 49.4233 1427.84 49.225 1426.42 49.1683C1425 49.055 1423.73 48.9983 1422.6 48.9983H1393.36V90.3083Z" fill="white"/>
<path d="M1332.7 152.188C1326.63 153.322 1320.68 153.803 1314.85 153.633C1309.07 153.52 1303.88 152.472 1299.29 150.488C1294.7 148.448 1291.22 145.247 1288.84 140.883C1286.74 136.917 1285.64 132.865 1285.52 128.728C1285.41 124.592 1285.35 119.917 1285.35 114.703V34.8882H1305.75V113.513C1305.75 117.197 1305.78 120.427 1305.84 123.203C1305.95 125.98 1306.55 128.247 1307.62 130.003C1309.66 133.403 1312.92 135.302 1317.4 135.698C1321.87 136.095 1326.97 135.868 1332.7 135.018V152.188ZM1268.69 76.4532V60.3882H1332.7V76.4532H1268.69Z" fill="white"/>
<path d="M1242.77 152.188V107.988C1242.77 105.098 1242.57 101.897 1242.18 98.3832C1241.78 94.8698 1240.84 91.4982 1239.37 88.2682C1237.95 84.9815 1235.8 82.2898 1232.91 80.1932C1230.08 78.0965 1226.22 77.0482 1221.35 77.0482C1218.74 77.0482 1216.17 77.4732 1213.62 78.3232C1211.07 79.1732 1208.74 80.6465 1206.65 82.7432C1204.61 84.7832 1202.96 87.6165 1201.72 91.2432C1200.47 94.8132 1199.85 99.4032 1199.85 105.013L1187.69 99.8282C1187.69 92.0082 1189.19 84.9248 1192.2 78.5782C1195.26 72.2315 1199.73 67.1882 1205.63 63.4482C1211.52 59.6515 1218.77 57.7532 1227.39 57.7532C1234.19 57.7532 1239.8 58.8865 1244.22 61.1532C1248.64 63.4198 1252.15 66.3098 1254.76 69.8232C1257.36 73.3365 1259.29 77.0765 1260.54 81.0432C1261.78 85.0098 1262.58 88.7782 1262.92 92.3482C1263.31 95.8615 1263.51 98.7232 1263.51 100.933V152.188H1242.77ZM1179.11 152.188V60.3882H1197.38V88.8632H1199.85V152.188H1179.11Z" fill="white"/>
<path d="M1128.04 154.738C1118.74 154.738 1110.58 152.726 1103.56 148.703C1096.53 144.68 1091.03 139.098 1087.07 131.958C1083.16 124.818 1081.2 116.601 1081.2 107.308C1081.2 97.2781 1083.13 88.5798 1086.98 81.2131C1090.83 73.7898 1096.19 68.0381 1103.05 63.9581C1109.9 59.8781 1117.84 57.8381 1126.85 57.8381C1136.37 57.8381 1144.44 60.0765 1151.07 64.5531C1157.76 68.9731 1162.72 75.2348 1165.95 83.3381C1169.18 91.4415 1170.39 100.99 1169.6 111.983H1149.29V104.503C1149.23 94.5298 1147.47 87.2481 1144.02 82.6581C1140.56 78.0681 1135.12 75.7731 1127.7 75.7731C1119.31 75.7731 1113.08 78.3798 1109 83.5931C1104.92 88.7498 1102.88 96.3148 1102.88 106.288C1102.88 115.581 1104.92 122.778 1109 127.878C1113.08 132.978 1119.03 135.528 1126.85 135.528C1131.89 135.528 1136.22 134.423 1139.85 132.213C1143.53 129.946 1146.37 126.688 1148.35 122.438L1168.58 128.558C1165.07 136.831 1159.63 143.263 1152.26 147.853C1144.95 152.443 1136.88 154.738 1128.04 154.738ZM1096.42 111.983V96.5131H1159.57V111.983H1096.42Z" fill="white"/>
<path d="M1026.94 195.538C1021.84 195.538 1016.93 194.745 1012.23 193.158C1007.58 191.571 1003.39 189.276 999.651 186.273C995.911 183.326 992.851 179.756 990.471 175.563L1009.34 166.213C1011.1 169.556 1013.56 172.021 1016.74 173.608C1019.97 175.251 1023.39 176.073 1027.02 176.073C1031.27 176.073 1035.07 175.308 1038.41 173.778C1041.75 172.305 1044.33 170.095 1046.15 167.148C1048.02 164.258 1048.89 160.631 1048.78 156.268V130.173H1051.33V60.3881H1069.27V156.608C1069.27 158.931 1069.15 161.141 1068.93 163.238C1068.76 165.391 1068.44 167.488 1067.99 169.528C1066.63 175.478 1064.02 180.351 1060.17 184.148C1056.32 188.001 1051.53 190.863 1045.81 192.733C1040.14 194.603 1033.85 195.538 1026.94 195.538ZM1025.15 154.738C1016.71 154.738 1009.34 152.613 1003.05 148.363C996.761 144.113 991.887 138.333 988.431 131.023C984.974 123.713 983.246 115.468 983.246 106.288C983.246 96.9948 984.974 88.7215 988.431 81.4681C991.944 74.1581 996.902 68.4065 1003.31 64.2131C1009.71 59.9631 1017.25 57.8381 1025.92 57.8381C1034.64 57.8381 1041.95 59.9631 1047.85 64.2131C1053.8 68.4065 1058.3 74.1581 1061.36 81.4681C1064.42 88.7781 1065.95 97.0515 1065.95 106.288C1065.95 115.411 1064.42 123.656 1061.36 131.023C1058.3 138.333 1053.74 144.113 1047.68 148.363C1041.61 152.613 1034.1 154.738 1025.15 154.738ZM1028.3 136.378C1033.79 136.378 1038.21 135.131 1041.56 132.638C1044.96 130.088 1047.42 126.546 1048.95 122.013C1050.54 117.48 1051.33 112.238 1051.33 106.288C1051.33 100.281 1050.54 95.0398 1048.95 90.5631C1047.42 86.0298 1045.01 82.5165 1041.73 80.0231C1038.44 77.4731 1034.19 76.1981 1028.98 76.1981C1023.48 76.1981 1018.95 77.5581 1015.38 80.2781C1011.81 82.9415 1009.17 86.5681 1007.47 91.1581C1005.77 95.6915 1004.92 100.735 1004.92 106.288C1004.92 111.898 1005.74 116.998 1007.39 121.588C1009.09 126.121 1011.66 129.72 1015.12 132.383C1018.58 135.046 1022.97 136.378 1028.3 136.378Z" fill="white"/>
<path d="M872.593 152.188L911.183 29.7883H941.188L979.778 152.188H958.698L923.678 42.3683H928.268L893.673 152.188H872.593ZM894.098 125.668V106.543H958.358V125.668H894.098Z" fill="white"/>
<path d="M817.738 152.188V107.988C817.738 105.098 817.54 101.897 817.143 98.3832C816.747 94.8698 815.812 91.4982 814.338 88.2682C812.922 84.9815 810.768 82.2898 807.878 80.1932C805.045 78.0965 801.192 77.0482 796.318 77.0482C793.712 77.0482 791.133 77.4732 788.583 78.3232C786.033 79.1732 783.71 80.6465 781.613 82.7432C779.573 84.7832 777.93 87.6165 776.683 91.2432C775.437 94.8132 774.813 99.4032 774.813 105.013L762.658 99.8282C762.658 92.0082 764.16 84.9248 767.163 78.5782C770.223 72.2315 774.7 67.1882 780.593 63.4482C786.487 59.6515 793.74 57.7532 802.353 57.7532C809.153 57.7532 814.763 58.8865 819.183 61.1532C823.603 63.4198 827.117 66.3098 829.723 69.8232C832.33 73.3365 834.257 77.0765 835.503 81.0432C836.75 85.0098 837.543 88.7782 837.883 92.3482C838.28 95.8615 838.478 98.7232 838.478 100.933V152.188H817.738ZM754.073 152.188V60.3882H772.348V88.8632H774.813V152.188H754.073Z" fill="white"/>
<path d="M703.003 154.738C693.71 154.738 685.55 152.726 678.523 148.703C671.496 144.68 666 139.098 662.033 131.958C658.123 124.818 656.168 116.601 656.168 107.308C656.168 97.2781 658.095 88.5798 661.948 81.2131C665.801 73.7898 671.156 68.0381 678.013 63.9581C684.87 59.8781 692.803 57.8381 701.813 57.8381C711.333 57.8381 719.408 60.0765 726.038 64.5531C732.725 68.9731 737.683 75.2348 740.913 83.3381C744.143 91.4415 745.361 100.99 744.568 111.983H724.253V104.503C724.196 94.5298 722.44 87.2481 718.983 82.6581C715.526 78.0681 710.086 75.7731 702.663 75.7731C694.276 75.7731 688.043 78.3798 683.963 83.5931C679.883 88.7498 677.843 96.3148 677.843 106.288C677.843 115.581 679.883 122.778 683.963 127.878C688.043 132.978 693.993 135.528 701.813 135.528C706.856 135.528 711.191 134.423 714.818 132.213C718.501 129.946 721.335 126.688 723.318 122.438L743.548 128.558C740.035 136.831 734.595 143.263 727.228 147.853C719.918 152.443 711.843 154.738 703.003 154.738ZM671.383 111.983V96.5131H734.538V111.983H671.383Z" fill="white"/>
<path d="M607.427 154.738C598.474 154.738 590.965 152.613 584.902 148.363C578.839 144.113 574.277 138.333 571.217 131.023C568.157 123.656 566.627 115.411 566.627 106.288C566.627 97.0515 568.157 88.7781 571.217 81.4681C574.277 74.1581 578.754 68.4065 584.647 64.2131C590.597 59.9631 597.935 57.8381 606.662 57.8381C615.332 57.8381 622.84 59.9631 629.187 64.2131C635.59 68.4065 640.549 74.1581 644.062 81.4681C647.575 88.7215 649.332 96.9948 649.332 106.288C649.332 115.468 647.604 123.713 644.147 131.023C640.69 138.333 635.817 144.113 629.527 148.363C623.237 152.613 615.87 154.738 607.427 154.738ZM563.142 192.988V60.3881H581.247V124.818H583.797V192.988H563.142ZM604.282 136.378C609.609 136.378 614 135.046 617.457 132.383C620.914 129.72 623.464 126.121 625.107 121.588C626.807 116.998 627.657 111.898 627.657 106.288C627.657 100.735 626.807 95.6915 625.107 91.1581C623.407 86.5681 620.772 82.9415 617.202 80.2781C613.632 77.5581 609.099 76.1981 603.602 76.1981C598.389 76.1981 594.139 77.4731 590.852 80.0231C587.565 82.5165 585.129 86.0298 583.542 90.5631C582.012 95.0398 581.247 100.281 581.247 106.288C581.247 112.238 582.012 117.48 583.542 122.013C585.129 126.546 587.594 130.088 590.937 132.638C594.337 135.131 598.785 136.378 604.282 136.378Z" fill="white"/>
<path d="M494.543 154.738C482.303 154.738 471.82 152.075 463.093 146.748C454.366 141.365 447.651 133.885 442.948 124.308C438.301 114.732 435.978 103.625 435.978 90.9883C435.978 78.3516 438.301 67.2449 442.948 57.6683C447.651 48.0916 454.366 40.6399 463.093 35.3133C471.82 29.9299 482.303 27.2383 494.543 27.2383C506.783 27.2383 517.266 29.9299 525.993 35.3133C534.776 40.6399 541.491 48.0916 546.138 57.6683C550.841 67.2449 553.193 78.3516 553.193 90.9883C553.193 103.625 550.841 114.732 546.138 124.308C541.491 133.885 534.776 141.365 525.993 146.748C517.266 152.075 506.783 154.738 494.543 154.738ZM494.543 135.443C502.76 135.5 509.588 133.687 515.028 130.003C520.525 126.32 524.633 121.135 527.353 114.448C530.13 107.762 531.518 99.9416 531.518 90.9883C531.518 82.0349 530.13 74.2716 527.353 67.6983C524.633 61.0683 520.525 55.9116 515.028 52.2283C509.588 48.5449 502.76 46.6466 494.543 46.5333C486.326 46.4766 479.498 48.2899 474.058 51.9733C468.618 55.6566 464.51 60.8416 461.733 67.5283C459.013 74.2149 457.653 82.0349 457.653 90.9883C457.653 99.9416 459.013 107.733 461.733 114.363C464.453 120.937 468.533 126.065 473.973 129.748C479.47 133.432 486.326 135.33 494.543 135.443Z" fill="white"/>
</svg>

After

Width:  |  Height:  |  Size: 20 KiB

20
apps/docs/logo/light.svg Normal file
View file

@ -0,0 +1,20 @@
<svg width="2018" height="197" viewBox="0 0 2018 197" fill="none" xmlns="http://www.w3.org/2000/svg">
<path d="M259.955 0.883301C308.707 0.883301 348.367 40.6825 348.367 89.6021C348.367 138.521 308.707 178.321 259.955 178.321H88.8623C40.1103 178.321 0.450287 138.521 0.450195 89.6021C0.450195 40.6826 40.1102 0.88338 88.8623 0.883301H259.955ZM252.577 117.774C249.963 117.449 247.308 117.741 244.827 118.626C242.347 119.512 240.109 120.966 238.295 122.872C236.481 124.777 235.14 127.082 234.382 129.599C233.624 132.116 233.468 134.776 233.929 137.364C234.389 139.951 235.453 142.396 237.033 144.499C238.613 146.601 240.667 148.305 243.027 149.471C245.388 150.638 247.991 151.235 250.626 151.214C254.22 151.187 257.712 150.012 260.588 147.861C263.464 145.71 265.575 142.696 266.609 139.261C267.644 135.827 267.549 132.152 266.338 128.776C265.127 125.399 262.864 122.498 259.88 120.498C257.693 119.032 255.191 118.099 252.577 117.774ZM105.583 38.186C98.2339 27.3088 75.0286 24.339 71.626 39.7065C71.6398 40.1804 71.4865 40.4868 71.0684 40.7935C69.1858 42.174 67.512 43.7368 66.1035 45.6333C62.6594 50.4444 62.1299 58.6025 66.4248 62.9253C66.5782 60.6384 66.6477 58.4904 68.4463 56.8589C71.7651 59.7176 76.7996 60.7354 80.6484 58.6021C89.1549 70.804 87.0355 87.6774 93.7988 100.828C95.6675 103.937 97.5507 107.117 99.9492 109.836C101.902 112.862 108.623 116.446 109.014 119.263C109.083 124.088 108.525 129.36 111.677 133.404C113.168 136.43 109.516 139.469 106.573 139.093C102.752 139.623 98.0939 136.513 94.7471 138.423C93.5619 139.706 91.2476 138.285 90.2295 140.069C89.8669 140.989 87.9561 142.287 89.0996 143.179C90.3686 142.217 91.5399 141.213 93.2412 141.785C92.9903 143.179 94.0915 143.375 94.9561 143.779C94.9281 144.713 94.3709 145.675 95.0957 146.484C95.9324 145.633 96.4347 144.42 97.7734 144.072C102.222 150.012 106.741 138.061 116.349 143.444C114.396 143.346 112.653 143.583 111.342 145.201C111.021 145.563 110.743 145.982 111.314 146.457C116.502 143.096 116.474 147.6 119.835 146.219C122.429 144.867 124.994 143.165 128.076 143.653C125.078 144.517 124.966 146.93 123.209 148.966C122.902 149.273 122.763 149.636 123.111 150.152C129.317 149.636 129.82 147.558 134.84 145.02C138.577 142.719 142.315 148.283 145.55 145.118C146.275 144.435 147.25 144.671 148.129 144.574C146.999 138.522 134.561 145.675 134.756 137.559C138.758 134.826 137.838 129.597 138.103 125.372C142.704 127.937 147.823 129.415 152.341 131.87C154.628 135.551 158.198 140.432 162.953 140.111C163.079 139.735 163.19 139.414 163.329 139.038C164.765 139.289 166.62 140.236 167.415 138.41C169.563 140.669 172.743 140.558 175.56 139.972L175.587 139.986C177.679 138.285 171.668 135.858 170.859 134.115C172.254 132.413 165.812 127.644 164.501 125.887C161.824 122.973 161.81 118.789 160.011 115.386C155.59 105.123 150.528 94.9431 143.43 86.2554C135.927 76.7587 126.682 68.8931 118.552 59.9683C112.528 53.7488 110.91 44.8797 105.583 38.186ZM222.09 70.0337C220.314 69.3923 218.442 69.0541 216.554 69.0327C212.105 69.0328 207.838 70.7907 204.691 73.9204C201.545 77.0503 199.777 81.2958 199.777 85.7222C199.777 90.1486 201.545 94.394 204.691 97.5239C207.838 100.654 212.104 102.413 216.554 102.413C218.443 102.391 220.314 102.052 222.09 101.411L231.779 115.764L238.741 111.091L229.137 96.7378C230.86 94.769 232.095 92.4251 232.743 89.895H258.496V81.5503H232.743C232.095 79.0203 230.86 76.6763 229.137 74.7075L238.825 60.354L231.779 55.6802L222.09 70.0337ZM262.701 60.5874L272.395 74.7378C269.757 77.7778 268.292 81.675 268.292 85.7222C268.292 90.1736 270.066 94.4426 273.221 97.5903C276.376 100.738 280.656 102.507 285.118 102.507C289.581 102.507 293.86 100.738 297.016 97.5903C300.171 94.4427 301.943 90.1736 301.943 85.7222C301.943 81.2706 300.171 77.0008 297.016 73.853C293.86 70.7052 289.581 68.9371 285.118 68.937C283.028 68.937 280.978 69.3243 279.065 70.0601L269.422 55.9829L262.701 60.5874ZM252.577 20.3052C249.963 19.9801 247.308 20.2723 244.827 21.1577C242.347 22.0431 240.109 23.4971 238.295 25.4028C236.481 27.3087 235.14 29.6133 234.382 32.1304C233.624 34.6474 233.468 37.3073 233.929 39.895C234.389 42.4828 235.453 44.9269 237.033 47.0298C238.613 49.1325 240.667 50.8359 243.027 52.0024C245.388 53.169 247.991 53.7669 250.626 53.7466C254.22 53.7188 257.712 52.543 260.588 50.3921C263.464 48.241 265.575 45.2269 266.609 41.7925C267.644 38.3583 267.549 34.6835 266.338 31.3071C265.127 27.9308 262.863 25.0299 259.88 23.0298C257.693 21.564 255.191 20.6303 252.577 20.3052Z" fill="#1C3C3C"/>
<path d="M1997.15 152.842V97.0823C1997.15 90.7923 1995.59 85.8906 1992.47 82.3773C1989.35 78.8073 1985.13 77.0223 1979.81 77.0223C1976.52 77.0223 1973.57 77.7873 1970.97 79.3173C1968.36 80.7906 1966.29 83.0006 1964.76 85.9473C1963.23 88.8373 1962.47 92.294 1962.47 96.3173L1953.37 90.9623C1953.31 84.6156 1954.73 79.034 1957.62 74.2173C1960.57 69.344 1964.53 65.5473 1969.52 62.8273C1974.51 60.1073 1980.06 58.7473 1986.18 58.7473C1996.32 58.7473 2004.09 61.8073 2009.47 67.9273C2014.91 73.9906 2017.63 81.9806 2017.63 91.8973V152.842H1997.15ZM1886.73 152.842V61.0423H1904.84V89.5173H1907.39V152.842H1886.73ZM1942.07 152.842V97.3373C1942.07 90.934 1940.51 85.9473 1937.39 82.3773C1934.27 78.8073 1930.02 77.0223 1924.64 77.0223C1919.43 77.0223 1915.23 78.8073 1912.06 82.3773C1908.94 85.9473 1907.39 90.594 1907.39 96.3173L1898.21 90.1973C1898.21 84.2473 1899.68 78.8923 1902.63 74.1323C1905.57 69.3723 1909.54 65.6323 1914.53 62.9123C1919.57 60.1356 1925.21 58.7473 1931.44 58.7473C1938.3 58.7473 1944.02 60.2207 1948.61 63.1673C1953.26 66.0573 1956.71 70.024 1958.98 75.0673C1961.3 80.054 1962.47 85.6923 1962.47 91.9823V152.842H1942.07Z" fill="#1C3C3C"/>
<path d="M1825.8 152.842V61.0422H1843.91V83.3972L1841.7 80.5072C1842.83 77.4472 1844.33 74.6705 1846.2 72.1772C1848.13 69.6272 1850.42 67.5305 1853.09 65.8872C1855.35 64.3572 1857.85 63.1672 1860.57 62.3172C1863.34 61.4105 1866.18 60.8722 1869.07 60.7022C1871.96 60.4755 1874.76 60.5889 1877.48 61.0422V80.1672C1874.76 79.3739 1871.62 79.1189 1868.05 79.4022C1864.53 79.6855 1861.36 80.6772 1858.53 82.3772C1855.69 83.9072 1853.37 85.8622 1851.56 88.2422C1849.8 90.6222 1848.5 93.3422 1847.65 96.4022C1846.8 99.4055 1846.37 102.664 1846.37 106.177V152.842H1825.8Z" fill="#1C3C3C"/>
<path d="M1768.06 155.392C1758.88 155.392 1750.86 153.324 1744 149.187C1737.15 145.051 1731.82 139.356 1728.02 132.102C1724.28 124.792 1722.41 116.406 1722.41 106.942C1722.41 97.3088 1724.34 88.8655 1728.19 81.6122C1732.05 74.3589 1737.4 68.6922 1744.26 64.6122C1751.11 60.5322 1759.05 58.4922 1768.06 58.4922C1777.29 58.4922 1785.34 60.5605 1792.2 64.6972C1799.05 68.8338 1804.38 74.5572 1808.18 81.8672C1811.97 89.1205 1813.87 97.4788 1813.87 106.942C1813.87 116.462 1811.95 124.877 1808.09 132.187C1804.3 139.441 1798.97 145.136 1792.11 149.272C1785.26 153.352 1777.24 155.392 1768.06 155.392ZM1768.06 136.182C1776.22 136.182 1782.28 133.462 1786.25 128.022C1790.21 122.582 1792.2 115.556 1792.2 106.942C1792.2 98.0455 1790.19 90.9622 1786.16 85.6922C1782.14 80.3655 1776.1 77.7022 1768.06 77.7022C1762.56 77.7022 1758.03 78.9488 1754.46 81.4422C1750.94 83.8789 1748.34 87.3072 1746.64 91.7272C1744.94 96.0905 1744.09 101.162 1744.09 106.942C1744.09 115.839 1746.1 122.951 1750.12 128.277C1754.2 133.547 1760.18 136.182 1768.06 136.182Z" fill="#1C3C3C"/>
<path d="M1681.38 152.842V59.5973C1681.38 57.274 1681.46 54.724 1681.63 51.9473C1681.8 49.114 1682.28 46.309 1683.08 43.5323C1683.87 40.7557 1685.31 38.234 1687.41 35.9673C1690.02 33.0773 1692.82 31.094 1695.83 30.0173C1698.89 28.884 1701.89 28.2607 1704.84 28.1473C1707.78 27.9773 1710.36 27.8923 1712.57 27.8923H1724.05V44.5523H1713.42C1709.51 44.5523 1706.59 45.544 1704.67 47.5273C1702.8 49.454 1701.86 52.004 1701.86 55.1773V152.842H1681.38ZM1666.59 77.1073V61.0423H1724.05V77.1073H1666.59Z" fill="#1C3C3C"/>
<path d="M1660.45 152.842C1654.38 153.976 1648.43 154.457 1642.6 154.287C1636.82 154.174 1631.63 153.126 1627.04 151.142C1622.45 149.102 1618.97 145.901 1616.59 141.537C1614.49 137.571 1613.38 133.519 1613.27 129.382C1613.16 125.246 1613.1 120.571 1613.1 115.357V35.5422H1633.5V114.167C1633.5 117.851 1633.53 121.081 1633.59 123.857C1633.7 126.634 1634.29 128.901 1635.37 130.657C1637.41 134.057 1640.67 135.956 1645.15 136.352C1649.62 136.749 1654.72 136.522 1660.45 135.672V152.842ZM1596.44 77.1072V61.0422H1660.45V77.1072H1596.44Z" fill="#1C3C3C"/>
<path d="M1541.16 155.392C1534.53 155.392 1528.92 154.146 1524.33 151.652C1519.74 149.102 1516.26 145.731 1513.88 141.537C1511.55 137.344 1510.39 132.726 1510.39 127.682C1510.39 123.262 1511.13 119.296 1512.6 115.782C1514.07 112.212 1516.34 109.152 1519.4 106.602C1522.46 103.996 1526.43 101.871 1531.3 100.227C1534.98 99.0372 1539.29 97.9605 1544.22 96.9972C1549.21 96.0339 1554.59 95.1555 1560.37 94.3622C1566.21 93.5122 1572.3 92.6055 1578.65 91.6422L1571.34 95.8072C1571.39 89.4605 1569.98 84.7855 1567.09 81.7822C1564.2 78.7788 1559.32 77.2772 1552.47 77.2772C1548.33 77.2772 1544.33 78.2405 1540.48 80.1672C1536.63 82.0938 1533.94 85.4088 1532.41 90.1122L1513.71 84.2472C1515.97 76.4839 1520.28 70.2505 1526.63 65.5472C1533.03 60.8439 1541.64 58.4922 1552.47 58.4922C1560.63 58.4922 1567.79 59.8239 1573.97 62.4872C1580.2 65.1505 1584.82 69.5138 1587.83 75.5772C1589.47 78.8072 1590.46 82.1222 1590.8 85.5222C1591.14 88.8655 1591.31 92.5205 1591.31 96.4872V152.842H1573.38V132.952L1576.35 136.182C1572.21 142.812 1567.37 147.686 1561.82 150.802C1556.32 153.862 1549.43 155.392 1541.16 155.392ZM1545.24 139.072C1549.89 139.072 1553.85 138.251 1557.14 136.607C1560.43 134.964 1563.03 132.952 1564.96 130.572C1566.94 128.192 1568.28 125.954 1568.96 123.857C1570.03 121.251 1570.63 118.276 1570.74 114.932C1570.91 111.532 1571 108.784 1571 106.687L1577.29 108.557C1571.11 109.521 1565.81 110.371 1561.39 111.107C1556.97 111.844 1553.17 112.552 1550 113.232C1546.83 113.856 1544.02 114.564 1541.59 115.357C1539.21 116.207 1537.19 117.199 1535.55 118.332C1533.91 119.466 1532.63 120.769 1531.73 122.242C1530.88 123.716 1530.45 125.444 1530.45 127.427C1530.45 129.694 1531.02 131.706 1532.15 133.462C1533.28 135.162 1534.93 136.522 1537.08 137.542C1539.29 138.562 1542.01 139.072 1545.24 139.072Z" fill="#1C3C3C"/>
<path d="M1476.34 152.842V27.8923H1496.83V152.842H1476.34Z" fill="#1C3C3C"/>
<path d="M1372.87 152.842V30.4424H1423.45C1424.64 30.4424 1426.17 30.499 1428.04 30.6124C1429.91 30.6691 1431.63 30.8391 1433.22 31.1224C1440.3 32.199 1446.14 34.5507 1450.73 38.1774C1455.38 41.804 1458.81 46.394 1461.02 51.9474C1463.28 57.4441 1464.42 63.5641 1464.42 70.3074C1464.42 76.9941 1463.28 83.1141 1461.02 88.6674C1458.75 94.1641 1455.29 98.7257 1450.65 102.352C1446.06 105.979 1440.25 108.331 1433.22 109.407C1431.63 109.634 1429.88 109.804 1427.95 109.917C1426.08 110.031 1424.58 110.087 1423.45 110.087H1393.36V152.842H1372.87ZM1393.36 90.9624H1422.6C1423.73 90.9624 1425 90.9057 1426.42 90.7924C1427.84 90.679 1429.14 90.4524 1430.33 90.1124C1433.73 89.2624 1436.39 87.7607 1438.32 85.6074C1440.3 83.4541 1441.69 81.0174 1442.49 78.2974C1443.34 75.5774 1443.76 72.9141 1443.76 70.3074C1443.76 67.7007 1443.34 65.0374 1442.49 62.3174C1441.69 59.5407 1440.3 57.0757 1438.32 54.9224C1436.39 52.769 1433.73 51.2674 1430.33 50.4174C1429.14 50.0774 1427.84 49.879 1426.42 49.8224C1425 49.709 1423.73 49.6524 1422.6 49.6524H1393.36V90.9624Z" fill="#1C3C3C"/>
<path d="M1332.7 152.842C1326.63 153.976 1320.68 154.457 1314.85 154.287C1309.07 154.174 1303.88 153.126 1299.29 151.142C1294.7 149.102 1291.22 145.901 1288.84 141.537C1286.74 137.571 1285.64 133.519 1285.52 129.382C1285.41 125.246 1285.35 120.571 1285.35 115.357V35.5422H1305.75V114.167C1305.75 117.851 1305.78 121.081 1305.84 123.857C1305.95 126.634 1306.55 128.901 1307.62 130.657C1309.66 134.057 1312.92 135.956 1317.4 136.352C1321.87 136.749 1326.97 136.522 1332.7 135.672V152.842ZM1268.69 77.1072V61.0422H1332.7V77.1072H1268.69Z" fill="#1C3C3C"/>
<path d="M1242.77 152.842V108.642C1242.77 105.752 1242.57 102.551 1242.18 99.0372C1241.78 95.5239 1240.84 92.1522 1239.37 88.9222C1237.95 85.6356 1235.8 82.9439 1232.91 80.8472C1230.08 78.7506 1226.22 77.7022 1221.35 77.7022C1218.74 77.7022 1216.17 78.1272 1213.62 78.9772C1211.07 79.8272 1208.74 81.3006 1206.65 83.3972C1204.61 85.4372 1202.96 88.2706 1201.72 91.8972C1200.47 95.4672 1199.85 100.057 1199.85 105.667L1187.69 100.482C1187.69 92.6622 1189.19 85.5789 1192.2 79.2322C1195.26 72.8856 1199.73 67.8422 1205.63 64.1022C1211.52 60.3056 1218.77 58.4072 1227.39 58.4072C1234.19 58.4072 1239.8 59.5406 1244.22 61.8072C1248.64 64.0739 1252.15 66.9639 1254.76 70.4772C1257.36 73.9906 1259.29 77.7306 1260.54 81.6972C1261.78 85.6639 1262.58 89.4322 1262.92 93.0022C1263.31 96.5156 1263.51 99.3772 1263.51 101.587V152.842H1242.77ZM1179.11 152.842V61.0422H1197.38V89.5172H1199.85V152.842H1179.11Z" fill="#1C3C3C"/>
<path d="M1128.04 155.392C1118.74 155.392 1110.58 153.381 1103.56 149.357C1096.53 145.334 1091.03 139.752 1087.07 132.612C1083.16 125.472 1081.2 117.256 1081.2 107.962C1081.2 97.9322 1083.13 89.2338 1086.98 81.8672C1090.83 74.4438 1096.19 68.6922 1103.05 64.6122C1109.9 60.5322 1117.84 58.4922 1126.85 58.4922C1136.37 58.4922 1144.44 60.7305 1151.07 65.2072C1157.76 69.6272 1162.72 75.8888 1165.95 83.9922C1169.18 92.0955 1170.39 101.644 1169.6 112.637H1149.29V105.157C1149.23 95.1839 1147.47 87.9022 1144.02 83.3122C1140.56 78.7222 1135.12 76.4272 1127.7 76.4272C1119.31 76.4272 1113.08 79.0339 1109 84.2472C1104.92 89.4039 1102.88 96.9688 1102.88 106.942C1102.88 116.236 1104.92 123.432 1109 128.532C1113.08 133.632 1119.03 136.182 1126.85 136.182C1131.89 136.182 1136.22 135.077 1139.85 132.867C1143.53 130.601 1146.37 127.342 1148.35 123.092L1168.58 129.212C1165.07 137.486 1159.63 143.917 1152.26 148.507C1144.95 153.097 1136.88 155.392 1128.04 155.392ZM1096.42 112.637V97.1672H1159.57V112.637H1096.42Z" fill="#1C3C3C"/>
<path d="M1026.94 196.192C1021.84 196.192 1016.93 195.399 1012.23 193.812C1007.58 192.226 1003.39 189.931 999.651 186.927C995.911 183.981 992.851 180.411 990.471 176.217L1009.34 166.867C1011.1 170.211 1013.56 172.676 1016.74 174.262C1019.97 175.906 1023.39 176.727 1027.02 176.727C1031.27 176.727 1035.07 175.962 1038.41 174.432C1041.75 172.959 1044.33 170.749 1046.15 167.802C1048.02 164.912 1048.89 161.286 1048.78 156.922V130.827H1051.33V61.0422H1069.27V157.262C1069.27 159.586 1069.15 161.796 1068.93 163.892C1068.76 166.046 1068.44 168.142 1067.99 170.182C1066.63 176.132 1064.02 181.006 1060.17 184.802C1056.32 188.656 1051.53 191.517 1045.81 193.387C1040.14 195.257 1033.85 196.192 1026.94 196.192ZM1025.15 155.392C1016.71 155.392 1009.34 153.267 1003.05 149.017C996.761 144.767 991.887 138.987 988.431 131.677C984.974 124.367 983.246 116.122 983.246 106.942C983.246 97.6488 984.974 89.3755 988.431 82.1222C991.944 74.8122 996.902 69.0605 1003.31 64.8672C1009.71 60.6172 1017.25 58.4922 1025.92 58.4922C1034.64 58.4922 1041.95 60.6172 1047.85 64.8672C1053.8 69.0605 1058.3 74.8122 1061.36 82.1222C1064.42 89.4322 1065.95 97.7055 1065.95 106.942C1065.95 116.066 1064.42 124.311 1061.36 131.677C1058.3 138.987 1053.74 144.767 1047.68 149.017C1041.61 153.267 1034.1 155.392 1025.15 155.392ZM1028.3 137.032C1033.79 137.032 1038.21 135.786 1041.56 133.292C1044.96 130.742 1047.42 127.201 1048.95 122.667C1050.54 118.134 1051.33 112.892 1051.33 106.942C1051.33 100.936 1050.54 95.6939 1048.95 91.2172C1047.42 86.6839 1045.01 83.1705 1041.73 80.6772C1038.44 78.1272 1034.19 76.8522 1028.98 76.8522C1023.48 76.8522 1018.95 78.2122 1015.38 80.9322C1011.81 83.5955 1009.17 87.2222 1007.47 91.8122C1005.77 96.3455 1004.92 101.389 1004.92 106.942C1004.92 112.552 1005.74 117.652 1007.39 122.242C1009.09 126.776 1011.66 130.374 1015.12 133.037C1018.58 135.701 1022.97 137.032 1028.3 137.032Z" fill="#1C3C3C"/>
<path d="M872.593 152.842L911.183 30.4424H941.188L979.778 152.842H958.698L923.678 43.0224H928.268L893.673 152.842H872.593ZM894.098 126.322V107.197H958.358V126.322H894.098Z" fill="#1C3C3C"/>
<path d="M817.738 152.842V108.642C817.738 105.752 817.54 102.551 817.143 99.0372C816.747 95.5239 815.812 92.1522 814.338 88.9222C812.922 85.6356 810.768 82.9439 807.878 80.8472C805.045 78.7506 801.192 77.7022 796.318 77.7022C793.712 77.7022 791.133 78.1272 788.583 78.9772C786.033 79.8272 783.71 81.3006 781.613 83.3972C779.573 85.4372 777.93 88.2706 776.683 91.8972C775.437 95.4672 774.813 100.057 774.813 105.667L762.658 100.482C762.658 92.6622 764.16 85.5789 767.163 79.2322C770.223 72.8856 774.7 67.8422 780.593 64.1022C786.487 60.3056 793.74 58.4072 802.353 58.4072C809.153 58.4072 814.763 59.5406 819.183 61.8072C823.603 64.0739 827.117 66.9639 829.723 70.4772C832.33 73.9906 834.257 77.7306 835.503 81.6972C836.75 85.6639 837.543 89.4322 837.883 93.0022C838.28 96.5156 838.478 99.3772 838.478 101.587V152.842H817.738ZM754.073 152.842V61.0422H772.348V89.5172H774.813V152.842H754.073Z" fill="#1C3C3C"/>
<path d="M703.003 155.392C693.71 155.392 685.55 153.381 678.523 149.357C671.496 145.334 666 139.752 662.033 132.612C658.123 125.472 656.168 117.256 656.168 107.962C656.168 97.9322 658.095 89.2338 661.948 81.8672C665.801 74.4438 671.156 68.6922 678.013 64.6122C684.87 60.5322 692.803 58.4922 701.813 58.4922C711.333 58.4922 719.408 60.7305 726.038 65.2072C732.725 69.6272 737.683 75.8888 740.913 83.9922C744.143 92.0955 745.361 101.644 744.568 112.637H724.253V105.157C724.196 95.1839 722.44 87.9022 718.983 83.3122C715.526 78.7222 710.086 76.4272 702.663 76.4272C694.276 76.4272 688.043 79.0339 683.963 84.2472C679.883 89.4039 677.843 96.9688 677.843 106.942C677.843 116.236 679.883 123.432 683.963 128.532C688.043 133.632 693.993 136.182 701.813 136.182C706.856 136.182 711.191 135.077 714.818 132.867C718.501 130.601 721.335 127.342 723.318 123.092L743.548 129.212C740.035 137.486 734.595 143.917 727.228 148.507C719.918 153.097 711.843 155.392 703.003 155.392ZM671.383 112.637V97.1672H734.538V112.637H671.383Z" fill="#1C3C3C"/>
<path d="M607.427 155.392C598.474 155.392 590.965 153.267 584.902 149.017C578.839 144.767 574.277 138.987 571.217 131.677C568.157 124.311 566.627 116.066 566.627 106.942C566.627 97.7055 568.157 89.4322 571.217 82.1222C574.277 74.8122 578.754 69.0605 584.647 64.8672C590.597 60.6172 597.935 58.4922 606.662 58.4922C615.332 58.4922 622.84 60.6172 629.187 64.8672C635.59 69.0605 640.549 74.8122 644.062 82.1222C647.575 89.3755 649.332 97.6488 649.332 106.942C649.332 116.122 647.604 124.367 644.147 131.677C640.69 138.987 635.817 144.767 629.527 149.017C623.237 153.267 615.87 155.392 607.427 155.392ZM563.142 193.642V61.0422H581.247V125.472H583.797V193.642H563.142ZM604.282 137.032C609.609 137.032 614 135.701 617.457 133.037C620.914 130.374 623.464 126.776 625.107 122.242C626.807 117.652 627.657 112.552 627.657 106.942C627.657 101.389 626.807 96.3455 625.107 91.8122C623.407 87.2222 620.772 83.5955 617.202 80.9322C613.632 78.2122 609.099 76.8522 603.602 76.8522C598.389 76.8522 594.139 78.1272 590.852 80.6772C587.565 83.1705 585.129 86.6839 583.542 91.2172C582.012 95.6939 581.247 100.936 581.247 106.942C581.247 112.892 582.012 118.134 583.542 122.667C585.129 127.201 587.594 130.742 590.937 133.292C594.337 135.786 598.785 137.032 604.282 137.032Z" fill="#1C3C3C"/>
<path d="M494.543 155.392C482.303 155.392 471.82 152.729 463.093 147.402C454.366 142.019 447.651 134.539 442.948 124.962C438.301 115.386 435.978 104.279 435.978 91.6423C435.978 79.0057 438.301 67.899 442.948 58.3223C447.651 48.7457 454.366 41.294 463.093 35.9673C471.82 30.584 482.303 27.8923 494.543 27.8923C506.783 27.8923 517.266 30.584 525.993 35.9673C534.776 41.294 541.491 48.7457 546.138 58.3223C550.841 67.899 553.193 79.0057 553.193 91.6423C553.193 104.279 550.841 115.386 546.138 124.962C541.491 134.539 534.776 142.019 525.993 147.402C517.266 152.729 506.783 155.392 494.543 155.392ZM494.543 136.097C502.76 136.154 509.588 134.341 515.028 130.657C520.525 126.974 524.633 121.789 527.353 115.102C530.13 108.416 531.518 100.596 531.518 91.6423C531.518 82.689 530.13 74.9257 527.353 68.3523C524.633 61.7223 520.525 56.5657 515.028 52.8823C509.588 49.199 502.76 47.3007 494.543 47.1873C486.326 47.1307 479.498 48.944 474.058 52.6273C468.618 56.3107 464.51 61.4957 461.733 68.1823C459.013 74.869 457.653 82.689 457.653 91.6423C457.653 100.596 459.013 108.387 461.733 115.017C464.453 121.591 468.533 126.719 473.973 130.402C479.47 134.086 486.326 135.984 494.543 136.097Z" fill="#1C3C3C"/>
</svg>

After

Width:  |  Height:  |  Size: 20 KiB

12
apps/docs/package.json Normal file
View file

@ -0,0 +1,12 @@
{
"name": "@open-swe/docs",
"author": "LangChain",
"repository": "https://github.com/langchain-ai/open-swe",
"private": true,
"scripts": {
"dev": "mint dev"
},
"devDependencies": {
"mint": "^4.1.19"
}
}

View file

@ -0,0 +1,39 @@
---
title: 'Authentication'
description: 'How authentication works in Open SWE'
---
(in this page, cover how the auth flow works in open swe)
- Discuss how we use GitHub Oauth for client side auth
- if user is not logged in, it will require them to login
- if they are logged in, it'll redirect them to the chat page
- users can update their gh auth via the `/settings` page
- Discuss LangGraph auth
- all requests made to the LangGraph server are authenticated
- when making requests from the client, they first go through a proxy route in the Next.js app.
- proxy route uses the `langgraph-nextjs-api-passthrough` package (https://www.npmjs.com/package/langgraph-nextjs-api-passthrough)
- this proxy route injects the following headers to the request:
- `GITHUB_TOKEN_COOKIE` (`"x-github-access-token"`) - this is the user's access token for github. it will allow us to take actions on behalf of the user, such as create gh issues and comments
- `GITHUB_INSTALLATION_TOKEN_COOKIE` (`"x-github-installation-token"`) - this is the installation token for the github app. it will allow us to take actions on behalf of the github app, such as make commits and open pull requests
- `GITHUB_INSTALLATION_NAME` (`"x-github-installation-name"`) - this is the name of the installation. will be either your github username if you're making requests against a repo your user owns, or an org name if making requests on a repo in an org
- all headers are prefixed with `x-` so that they are included in the configurable field of the langgraph runs, so we can access them during a run and not only in the auth middleware
- all secrets (gh tokens) are encrypted in this proxy route to prevent them being exposed in LangSmith traces, or if other users are somehow able to access your threads/runs.
- finally, the request is forwarded to your actual langgraph server, where it first runs through an auth middleware to verify the user is authenticated.
- the first check in the langgraph server auth middleware looks to see if a header is present which would indicate the request is coming from a github webhook
- if true, it will verify the webhook signature, and authorize it if so. we do not include the user information in this auth step, as that is done in the next request that the webhook handler makes to actually create a new langgraph run based on the webhook event. here is where your gh user is included so that the thread/run created by this webhook is only exposed to you, the user.
- all requests made to the langgraph server go through this auth middleware. this includes requests to custom routes (like the webhook handler) and requests made to the langgraph server (like creating a new thread/run)
- if it's not a webhook request, we check for two required headers
- the installation name
- the installation token
- if either are not defined, we throw a 401 unauthorized error
- after getting these headers, we check to see if there's a github access token (tied to a user)
- if there is, we use that to verify the user. this would indicate the request was made from the web app
- if there isn't, we check for two additional headers
- the user id
- the user login
- after getting these values, we verify the user ID & login passed in headers are valid, and that the installation token is valid
- this occurs when a run is created from a github webhook
- finally, after validating either the github user id & login, or getting the user ID and login from the user's github access token, we return a new identity object. this contains the user's ID, and the installation name. we use the user ID to ensure the only resources you're allowed to access are your own. the auth middleware then forwards to a handler which runs for each resource type (e.g. create new thread). in this handler we add your user id to metadata if it's a create request, and if it's a get request we verify the user id from the identity matches the one in the metadata.
- since the access tokens/installation tokens are prefixed with `x-` they're going to be included in the configurable field of the langgraph runs (still encrypted). so whenever we need to take some action (e.g. create new issue) we first extract that field from the configurable field, decrypt, then preform the action.

View file

@ -0,0 +1,54 @@
---
title: 'Development Setup'
description: 'How to set up Open SWE for development'
---
(in this page, cover what is needed to set up Open SWE for development)
- clone repo
- install deps
- copy env example files from both `apps/web/.env.example` & `apps/open-swe/.env.example`
- discuss filling in values for each (excluding GH app values. note that we'll cover that in the next step)
- create gh app
- mention having a dev github app and a prod github app
- add callout that this is a GitHub App, which is not the same as a GitHub oauth app
- walk through setup & permissions:
- https://github.com/settings/apps/new to create new github app
- give it a name & description
- set homepage url to your URL, or repo readme if no url
- set callback url to `http://localhost:3000/api/auth/github/callback` for dev
- uncheck `Expire user authorization tokens` so that the users tokens never expire
- check `Request user authorization (OAuth) during installation` so that we can allow users to use our gh app for login to the web app
- check `Redirect on update` so users are always redirected back to your app after updating permissions
- enable webhook
- set webhook url to `/webhook/github`. suggest using ngrok to create a public url which points to your local `http://localhost:2024` server for dev (`/webhook/github` is a custom route added to your langgraph server)
- create secret: `openssl rand -hex 32` and set this as the webhook secret, and save it under the `GITHUB_WEBHOOK_SECRET` in the `apps/open-swe/.env` file
- set permissions:
- Repository permissions:
- `Contents`: `Read & Write`
- `Issues`: `Read & Write`
- `Pull requests`: `Read & Write`
- `Metadata`: `Read only` (mandatory, will be enabled for you)
- Organization permissions:
- None
- Account permissions:
- None
- Subscribe to events:
- `Issues` - required for webhook to work
- `Where can this GitHub App be installed?`: `Any account` (or `Only on this account` if you want to limit it to your own account)
- Create GitHub App
- After creating app, we'll now be able to get/create secrets:
- `GITHUB_APP_NAME`: name of the app, e.g. `open-swe-dev`
- `GITHUB_APP_ID`: `App ID` of the app, e.g. `12345678`
- `GITHUB_APP_PRIVATE_KEY`: `Private key` of the app. To generate, scroll down to the `Private keys` section and generate a new one. e.g. `-----BEGIN RSA PRIVATE KEY-----\n...add your private key here...\n-----END RSA PRIVATE KEY-----\n`
- `GITHUB_APP_CLIENT_ID`: `Client ID` of the app
- `GITHUB_APP_CLIENT_SECRET`: Under the `Client secrets` section, click `Generate new client secret` and copy the value.
- done
- after setting all your env vars, you can now start the agent & web app servers
- `cd apps/open-swe` - `yarn dev` - starts a development server at `http://localhost:2024`
(in a separate terminal window)
- `cd apps/web` - `yarn dev` - starts a development server at `http://localhost:3000`
Done! Now you can visit `http://localhost:3000` to see the web app, and start using Open SWE!

15
apps/docs/setup/index.mdx Normal file
View file

@ -0,0 +1,15 @@
---
title: 'Introduction'
description: 'How to set up Open SWE for development'
---
(in this page, cover what the setup pages include, and link to them)
- link to each individual page: monorepo, development, authentication
- discuss what tech is used
- typescript
- yarn
- turbo repo
- next.js for web app
- langgraph for agent
- mintlify for docs

View file

@ -0,0 +1,19 @@
---
title: 'Monorepo'
description: 'How the Open SWE monorepo is configured'
---
(in this page, cover the monorepo structure, and best practices for using it)
- cover the repo structure:
- monorepo
- `apps/open-swe` contains the agent
- `apps/web` contains the web app
- `apps/docs` contains the docs
- `packages/shared` contains shared utils, types, etc. any code which is used in both the agent & web app should go here
- turbo repo for monorepo management
- install deps in specific packages theyre used in, never in root
- only time to install deps in root is when adding a resolution. if multiple apps/packages share a dependency, add the resolution to root so that they all use the same version
- run build from root or `packages/shared` when making a change in `shared` and want access in other packages
- mention that the `apps/open-swe` package has a `postinstall` hook which runs `yarn build` after installing deps.
- this is required so that we can deploy on langgraph platform. since open swe is a monorepo and the agent requires accessing built files from the shared repo, we must run build before we can start the langgraph server

View file

@ -0,0 +1,6 @@
---
title: 'Introduction'
description: 'How to use Open SWE'
---
(in this page, cover the high level ways you can use open swe, and link to each individual page for more details. also, link to the public demo and mention that you can use a deployed version from it)

17
apps/docs/usage/ui.mdx Normal file
View file

@ -0,0 +1,17 @@
---
title: 'From the UI'
description: 'How to use Open SWE from the UI'
---
(in this page, cover how you can use Open SWE from the UI. Do not include screenshots, I will manually add those later)
discuss:
- Auto mode vs manual mode
- chatting with the agent (manager)
- what the manager can do: respond to user, create new planning run, send new message to active planning run, resume the planner after interrupted with a response, send new message to active programmer run
- what the manager can NOT do: create new programmer run (this can only happen by accepting the proposed plan/auto mode after plan is complete), stop the planner/programmer. re-plan while the programmer is running. open a PR (this will only happen after the programmer finishes. the programmer will always auto-commit after every change though), accept a plan (you need to manually click accept if not running in auto-mode)
- overview of how the manager can take actions:
- how messages you send to the manager trigger planning runs
- how messages you send to the manager can add new messages to planning run while its active
- how messages you send to the manager can resume the planner if it's interrupted w/ a proposed plan
- how messages you send to the manager can send new messages to active programmer run

View file

@ -0,0 +1,12 @@
---
title: 'From Webhooks'
description: 'How to use Open SWE from webhooks'
---
(in this page, cover how you can trigger open swe from webhooks, specifically github issues)
- discuss how adding a label to a GH issue that Open SWE is installed on can trigger a run
- cover manual vs auto mode (`open-swe` vs `open-swe-auto`)
- cover how open swe will reply to the issue with a message confirming it's started a new run, and it will include a link to the new run so you can view it in the open swe UI
- cover how only the user who created the issue will be able to view this URL
- discuss how PRs will link back to the issue that triggered it, so when the PR is closed, it will close the issue

View file

@ -20,8 +20,6 @@ GITHUB_APP_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
...add your private key here...
-----END RSA PRIVATE KEY-----
"
# Secret key for verifying GitHub webhook events.
GITHUB_WEBHOOK_SECRET=""
# ------------------------Other------------------------

4121
yarn.lock

File diff suppressed because it is too large Load diff