Skip to content

Commit

Permalink
docs: update docfx custom theme
Browse files Browse the repository at this point in the history
fix(actions): supply token to delete artifacts
chore(housekeeping): enforce issue templates
  • Loading branch information
Lulalaby committed Jan 8, 2024
1 parent 87284dd commit a8ccdab
Show file tree
Hide file tree
Showing 345 changed files with 4,703 additions and 6,453 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

67 changes: 67 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Bug Report
description: Report broken or incorrect behaviour
labels: unconfirmed bug
body:
- type: markdown
attributes:
value: >
Thanks for taking the time to fill out a bug. If you want real-time support,
consider joining our Discord at DISCORD_INVITE instead.
Please note that this form is for bugs only!
- type: input
attributes:
label: Summary
description: A simple summary of your bug report
validations:
required: true
- type: textarea
attributes:
label: Reproduction Steps
description: >
What you did to make it happen.
validations:
required: true
- type: textarea
attributes:
label: Minimal Reproducible Code
description: >
A short snippet of code that showcases the bug.
render: python
- type: textarea
attributes:
label: Expected Results
description: >
What did you expect to happen?
validations:
required: true
- type: textarea
attributes:
label: Actual Results
description: >
What actually happened?
validations:
required: true
- type: textarea
attributes:
label: System Information
description: >
Send us all the information you can about your system.
validations:
required: true
- type: checkboxes
attributes:
label: Checklist
description: >
Let's make sure you've properly done due diligence when reporting this issue!
options:
- label: I have searched the open issues for duplicates.
required: true
- label: I have shown the entire traceback, if possible.
required: true
- label: I have removed my token from display, if visible.
required: true
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Discord Server
about: Use our official Discord server to ask for help
url: https://discord.gg/Uk7sggRBTm
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Feature Request
description: Suggest a feature for this library
labels: feature request
body:
- type: input
attributes:
label: Summary
description: >
A short summary of what your feature request is.
validations:
required: true
- type: textarea
attributes:
label: The Problem
description: >
What problem is your feature trying to solve? What becomes easier or possible
when this feature is implemented?
validations:
required: true
- type: textarea
attributes:
label: The Ideal Solution
description: >
What is your ideal solution to the problem? What would you like this feature to
do?
validations:
required: true
- type: textarea
attributes:
label: The Current Solution
description: >
What is the current solution to the problem, if any?
validations:
required: false
- type: textarea
attributes:
label: Additional Context
description: If there is anything else to say, please do so here.
2 changes: 1 addition & 1 deletion .github/SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

## Reporting a Vulnerability

Write an mail to [email protected] or open an ticket at our guild.
Write an mail to [email protected] or open an ticket in our discord server.
4 changes: 3 additions & 1 deletion .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,9 @@

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes {T} (aitsys.dev issue)
<!-- If this relates to an aitsys.dev issue:
Fixes {TXXX} (aitsys.dev issue)
-->

## Type of change

Expand Down
1 change: 1 addition & 0 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ jobs:
uses: geekyeggo/delete-artifact@v4
with:
name: dcs-ext-docs.zip
token: ${{ secrets.NYUW_TOKEN_GH }}
- name: Add .htaccess
run: rm -f .htaccess && wget https://gist.githubusercontent.com/Lulalaby/8a032d0ddebb9125691094edc67b6593/raw/0c4bf0423cfe334fdd5092b014d2481759dd052a/.htaccess
- name: Set access rights
Expand Down
6 changes: 6 additions & 0 deletions DisCatSharp.Extensions.Docs/dcs/ApiPage.html.primary.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.

exports.transform = function (model) {
return model;
}
4 changes: 4 additions & 0 deletions DisCatSharp.Extensions.Docs/dcs/ApiPage.html.primary.tmpl
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}}
{{!master(layout/_master.tmpl)}}

{{{content}}}
30 changes: 14 additions & 16 deletions DisCatSharp.Extensions.Docs/dcs/layout/_master.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -113,10 +113,10 @@
profiles: {
dcs: {
author: "DisCatSharp",
avatar: "https://cdn.discordapp.com/avatars/887519008604180541/cc3b7410330027b0682900b6c612b735.png?size=256",
avatar: "https://i.imgur.com/sHdXUPx.png",
roleColor: "#eb0404",
roleName: "System Bots",
roleIcon: "https://cdn.discordapp.com/role-icons/858098536759820379/bda0df094fa6f95b01c4846518034835.png?size=256",
roleIcon: "https://i.imgur.com/kcovdK8.png",
bot: true,
verified: true
},
Expand All @@ -128,31 +128,30 @@
},
dcs_user: {
author: "Drac",
avatar: "https://cdn.discordapp.com/avatars/666339628613107725/a97c269a653ecc2ff143f7bddb36a782.png?size=256",
avatar: "https://i.imgur.com/DTRl2vx.png",
roleColor: "#a221e6",
roleName: "VIP",
roleIcon: "https://cdn.discordapp.com/role-icons/858099411434209280/ce6432b51488efd0fa09fadb12cbfb47.png?size=256"
roleIcon: "https://i.imgur.com/KISyx38.png"
},
dcs_owner: {
author: "Lala Sabathil",
avatar: "https://cdn.discordapp.com/avatars/856780995629154305/cca4f0fdd07fa17a31f99139f8f45e87.png?size=256",
avatar: "https://i.imgur.com/BhmIcP1.png",
roleColor: "#fc0fc0",
roleName: "AITSYS Leader",
roleIcon: "https://cdn.discordapp.com/role-icons/1070126281422819380/b829ba0483ed2723034292651731f357.png?size=256"
roleIcon: "https://i.imgur.com/IFqSKnw.png"
},
user_dm: {
author: "Discord User",
avatar: "https://cdn.discordapp.com/embed/avatars/5.png"
},
dcs_user_dm: {
author: "Drac",
avatar: "https://cdn.discordapp.com/avatars/666339628613107725/a97c269a653ecc2ff143f7bddb36a782.png?size=256"
avatar: "https://i.imgur.com/DTRl2vx.png"
}
},
defaultMode: "cozy",
defaultTheme: "amoled", // replace with amoled soon
defaultBackground: "discord",
useTwentyFourHourMode: true
defaultTheme: "dark", // replace with amoled soon
defaultBackground: "discord"
};
</script>
<script type="module" src="https://unpkg.com/@aitsys/discord-components-core"></script>
Expand Down Expand Up @@ -187,6 +186,7 @@
<meta name="loc:themeAuto" content="{{__global.themeAuto}}">
<meta name="loc:changeTheme" content="{{__global.changeTheme}}">
<meta name="loc:copy" content="{{__global.copy}}">
<meta name="loc:downloadPdf" content="{{__global.downloadPdf}}">
<script src="//code.jquery.com/jquery-latest.js"></script>
<script defer src='https://static.cloudflareinsights.com/beacon.min.js'
data-cf-beacon='{"token": "de6c22ce0b3e4c17bb78c8c31b4e695b"}'></script>
Expand All @@ -198,11 +198,8 @@
{{/redirect_url}}
</head>
{{^redirect_url}}
<script type="module">
import options from './{{_rel}}public/main.js'
import { init } from './{{_rel}}public/docfx.min.js'
init(options)
</script>
<script type="module" src="./{{_rel}}public/main.js"></script>
<script type="module" src="./{{_rel}}public/docfx.min.js"></script>

<script>
const theme = 'dark' //localStorage.getItem('theme') || 'auto'
Expand Down Expand Up @@ -292,6 +289,7 @@
{{^_disableNextArticle}}
<div class="next-article d-print-none border-top" id="nextArticle"></div>
{{/_disableNextArticle}}

</div>

<div class="affix">
Expand All @@ -303,7 +301,7 @@
<div class="container-xxl search-results" id="search-results"></div>
{{/_enableSearch}}

<footer class="border-top">
<footer class="border-top text-secondary">
<div class="container-xxl">
<div class="flex-fill">
{{{_appFooter}}}{{^_appFooter}}<span>Made with <a
Expand Down
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit a8ccdab

Please sign in to comment.