Update docs

This commit is contained in:
Ategon 2024-02-17 15:15:27 -05:00
parent 852a7723a4
commit ce41e238f8
18 changed files with 150 additions and 42 deletions

View File

@ -1,4 +1,26 @@
.book-menu-content nav ul:nth-child(5) { .book-menu-content nav ul:nth-child(3) {
color: gray;
label a img {
color: gray;
filter: invert(0.4)
}
}
.book-search {
input {
transition: all;
transition-duration: 300ms;
width: 100%;
&:focus {
width: 102%;
color: gold;
}
}
}
.book-menu-content nav ul:nth-child(6) {
padding-top: 20px; padding-top: 20px;
color: gray; color: gray;
} }
@ -8,13 +30,6 @@
outline-color: transparent; outline-color: transparent;
} }
@media (prefers-color-scheme: dark) {
:root {
--body-background: #121212
}
}
.book-menu { .book-menu {
strong { strong {
color: gray; color: gray;
@ -52,6 +67,9 @@
} }
.book-page { .book-page {
article p:nth-child(2){
color: gray;
}
a { a {
color: rgb(70, 100, 200); color: rgb(70, 100, 200);
} }

17
assets/_variables.scss Normal file
View File

@ -0,0 +1,17 @@
@mixin theme-dark {
--gray-100: rgba(255, 255, 255, 0.1);
--gray-200: rgba(255, 255, 255, 0.2);
--gray-500: rgba(255, 255, 255, 0.5);
--color-link: #84b2ff;
--color-visited-link: #b88dff;
--body-background: #121212;
--body-font-color: #d9dcdf;
--icon-filter: brightness(0) invert(1);
--hint-color-info: #6bf;
--hint-color-warning: #fd6;
--hint-color-danger: #f66;
}

View File

@ -0,0 +1,3 @@
---
BookMenuBundle: '/menu/test'
---

View File

@ -52,7 +52,7 @@ These guidelines are for tool usage for semi-automated actions or things that do
As some software doesn't have this built in currently you can just put the information in your bio. This could be something such as "Some actions in this account are automated", "Cyborg account", or "Uses some automation tools". You could also put what specific things you use if you want but it is not required. If the software supports marking an account as a cyborg you can use that instead. As some software doesn't have this built in currently you can just put the information in your bio. This could be something such as "Some actions in this account are automated", "Cyborg account", or "Uses some automation tools". You could also put what specific things you use if you want but it is not required. If the software supports marking an account as a cyborg you can use that instead.
## Do we Make Updates to these Automation Guidelines? ## Do we Make Updates to these Automation Guidelines?
We may update the Automation Guidelines from time to time. When we do, we will change the "Last Updated" date and author at the top of the page to indicate the date and author of the most recent changes. If we make changes we may notify you by posting a notice of such changes or by sending you a notification. We encourage you to review these Automation Guidelines periodically for any modifications. We may update the Automation Guidelines from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes in our meta community on the programming.dev site, in the updates account on the bytes.programming.dev site, in the news community in our discord server, and in the news community in our matrix server. We encourage you to review the Automation Guidelines periodically for any modifications.
## Contact Us ## Contact Us
If you have questions or concerns about these Automation Guidelines you should contact us at info@programming.dev. If you have questions or concerns about these Automation Guidelines you should contact us at info@programming.dev.

View File

@ -31,28 +31,22 @@ The following are not allowed in any of our sites and may result in you being ac
Some communities within one of our sites may have additional or more specific guidelines in the community description that are expected to be followed when interacting in that community. Failure to follow those guidelines may result in you being actioned upon by moderators. Some communities within one of our sites may have additional or more specific guidelines in the community description that are expected to be followed when interacting in that community. Failure to follow those guidelines may result in you being actioned upon by moderators.
## Automation Guidelines ## Automation Guidelines
If you use any form of automation on your accounts you must abide by our [Automation Guidelines](https://github.com/programming-dot-dev/p.d-legal/blob/main/AUTOMATION-GUIDELINES.md). If you use any form of automation on your accounts you must abide by our [Automation Guidelines](https://legal.programming.dev/docs/automation-guidelines).
## Community Guidelines
If you manage a community on our sites you must abide by our [Community Guidelines](https://legal.programming.dev/docs/community-guidelines).
## Moderator Guidelines
If you are a moderator for our sites or for a community on our sites you must abide by our [Moderator Guidelines](https://legal.programming.dev/docs/moderator-guidelines).
## Admin Guidelines
If you are an admin for our sites you must abide by our [Admin Guidelines](https://legal.programming.dev/docs/admin-guidelines).
## Reporting ## Reporting
When you see someone not behaving according to our code of conduct, if theres a report button built into the software (which should be most software we host) you can report them for the community team in charge of that software to be able to deal with it. If theres no report button email info@programming.dev with the report information. When you see someone not behaving according to our code of conduct, if theres a report button built into the software (which should be most software we host) you can report them for the community team in charge of that software to be able to deal with it. If theres no report button email info@programming.dev with the report information.
## Moderator Guidelines
These are guidelines to follow when being a moderator for a community (community in this sense refers to user run communities such as on programming.dev).
### Respect the CoC
When managing your community you may make rules for members interacting in that community to follow. These should not contradict our CoC (Code of Conduct).
### Handle Reports
Users interacting in your community may make reports on content. This is expected to be handled swiftly (at most a day to action) to ensure that users in your community are following our CoC and your community rules. If a user breaks the CoC it may be handled by an admin as well but this should not be relied on as admins have many tasks around the sites to deal with.
### Be Active
Moderators of a community are expected to be active on our site and communities should not be without moderation for long periods of time. If community moderators are no longer using the site and thus the community is going without moderation the communities may be transferred to new moderators. We will attempt to contact the current moderators of the community before transferring it.
### Respect Your Scope
If a user does something in another community such as make a comment this should not affect their usage of your community. If you notice behaviour that breaks the CoC in other communities this should instead be reported so those community moderators or admins may deal with it.
## Do we Make Updates to this Code of Conduct? ## Do we Make Updates to this Code of Conduct?
We may update the Code of Conduct from time to time. When we do, we will change the "Last Updated" date and author at the top of the page to indicate the date and author of the most recent changes. If we make changes we may notify you by posting a notice of such changes or by sending you a notification. We encourage you to review the Code of Conduct periodically for any modifications. We may update the Code of Conduct from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes or by sending you a notification. We encourage you to review the Code of Conduct periodically for any modifications.
## Contact Us ## Contact Us
If you have questions or concerns about this Code of Conduct you should contact us at info@programming.dev. If you have questions or concerns about this Code of Conduct you should contact us at info@programming.dev.

View File

@ -0,0 +1,12 @@
# Community Guidelines
These Community Guidelines detail expected conduct and suggested actions when managing a community on Programming.Dev ("programming.dev", "we", "us", "our") sites.
## 1. Community Info
## 2.
## Do we Make Updates to these Community Guidelines?
We may update the Community Guidelines from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes in our meta community on the programming.dev site, in the updates account on the bytes.programming.dev site, in the news community in our discord server, and in the news community in our matrix server. We encourage you to review the Community Guidelines periodically for any modifications.
## Contact Us
If you have questions or concerns about these Community Guidelines you should contact us at info@programming.dev.

View File

View File

@ -1,4 +1,4 @@
# Defederation Policy # 🌍 Defederation Policy
This document details how Programming.Dev ("programming.dev", "we", "us", "our") choose to defederate with other instances. If an instance wishes to be federated and thus have their content show on our sites they must abide by the policy and ensure they do not do one of the actions in the how an instance gets defederated section. This document details how Programming.Dev ("programming.dev", "we", "us", "our") choose to defederate with other instances. If an instance wishes to be federated and thus have their content show on our sites they must abide by the policy and ensure they do not do one of the actions in the how an instance gets defederated section.
## What is Defederation? ## What is Defederation?
@ -6,10 +6,10 @@ Our sites are federated with other instances. Instances are essentially sites bu
Defederating from a instance: Defederating from a instance:
- Makes users from our sites not be able to see things such as posts and comments from users on that instance. - Makes users from our sites not be able to see things such as posts and comments from users on that instance.
- Makes users from that instance no longer be able to interact with communities or users on our sites. - Makes users from that instance no longer be able to interact with communities or users on our sites in a way thats visible outside of their instance.
## How does an instance get defederated? ## How does an instance get defederated?
- Instances may be defederated if they break our [Code of Conduct](https://github.com/programming-dot-dev/p.d-legal/blob/main/CODE-OF-CONDUCT.md) whether though encouraging something we disallow or not moderating users that break it. - Instances may be defederated if they break our [Code of Conduct](https://legal.programming.dev/docs/code-of-conduct) whether though encouraging something we disallow or not moderating users that break it.
- Instances that have no active administrators may be defederated. - Instances that have no active administrators may be defederated.
- Instances that have a lack of security that is not addressed and that puts our users at risk may be defederated. This includes things like having a sign up process that does not stop bots from mass creating accounts. - Instances that have a lack of security that is not addressed and that puts our users at risk may be defederated. This includes things like having a sign up process that does not stop bots from mass creating accounts.
- Instances that have defederated from us may be defederated to prevent one way conversations where we get content from the other instance but users commenting on that content get no response. - Instances that have defederated from us may be defederated to prevent one way conversations where we get content from the other instance but users commenting on that content get no response.
@ -35,8 +35,11 @@ Microblogs
more to be added here. Full list is visible on fediseer or our site federation tab if it exists more to be added here. Full list is visible on fediseer or our site federation tab if it exists
``` ```
## Do we Make Updates to this Defederation Policy? ## Defederation Appeals
We may update the Defederation Policy from time to time. When we do, we will change the "Last Updated" date and author at the top of the page to indicate the date and author of the most recent changes. If we make changes we may notify you by posting a notice of such changes or by sending you a notification. We encourage you to review the Defederation Policy periodically for any modifications. If you are the admin of an instance we have defederated, you wish to reverse the defederation, and you follow our [Code of Conduct](https://legal.programming.dev/docs/code-of-conduct) contact us as info@programming.dev.
## Are Updates Made to this Defederation Policy?
We may update the Defederation Policy from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes in our meta community on the programming.dev site, in the updates account on the bytes.programming.dev site, in our blog on the stacks.programming.dev site, in the news community in our discord server, and in the news community in our matrix server. We encourage you to review the Defederation Policy periodically for any modifications.
## Contact Us ## Contact Us
If you have questions or concerns about this Defederation Policy you should contact us at info@programming.dev. If you have questions or concerns about this Defederation Policy you should contact us at info@programming.dev.

View File

@ -1,5 +1,5 @@
# Donation Policy # ❤️ Donation Policy
This is a policy that describes how Programming.Dev ("programming.dev", "we", "us", "our") handles donations towards us. This is a policy that describes how Programming.Dev ("programming.dev", "we", "us", "our") handles and spends donations made towards us.
## How are Donations Made? ## How are Donations Made?
Donations are currently made using [snowe's github sponsors page](https://github.com/sponsors/snowe2010/). If you get another place to donate that is not this it is fake and should be reported to us. Donations are currently made using [snowe's github sponsors page](https://github.com/sponsors/snowe2010/). If you get another place to donate that is not this it is fake and should be reported to us.
@ -7,25 +7,25 @@ Donations are currently made using [snowe's github sponsors page](https://github
## How are Donations Spent? ## How are Donations Spent?
Donations are spent on things relating to our sites. This includes things such as server costs, infrastructure costs, tool costs, and payment for work done relating to it. Donations are spent on things relating to our sites. This includes things such as server costs, infrastructure costs, tool costs, and payment for work done relating to it.
## Who is considered a donator? ## Who is Considered a Donator?
Donators are people who have at one point made a donation towards us regardless on whether they are currently doing a monthly donation, did one in the past, or did a one time donation. Donators are people who have at one point made a donation towards us regardless on whether they are currently doing a monthly donation, did one in the past, or did a one time donation.
## Donation Perks ## Donation Perks
We offer perks towards donators that have at one point made a donation towards us. These are the current perks donators get: We offer perks towards donators that have at one point made a donation towards us. These are the current perks donators get:
- A donator role on our discord server - A donator role on our discord server.
- An account on our linkstack site https://me.programming.dev for sharing links related to you in one page - An account on our linkstack site https://me.programming.dev for sharing links related to you in a page.
## Donation Perk Terms ## Donation Perk Terms
By donating to programming.dev you acknowledge and agree to the following terms: By donating to programming.dev you acknowledge and agree to the following terms:
- **Display Proof:** To get access to a perk you must be able to prove that you are the one that made the donation. - **Display Proof:** To get access to a perk you must be able to prove that you are the one that made the donation.
- **Account Requirement:** Access to a perk requires an account on the platform the perk is on. For example to get a discord role you need a discord account. - **Account Requirement:** Access to a perk requires an account on the platform the perk is on. For example to get a discord role you need a discord account.
- **Request Perks:** To get a perk you need to request it from a community team admin in charge of the software the perk is on. - **Request Perks:** To get a perk you need to request it from a community team admin in charge of the software the perk is on or from our contact email at info@programming.dev.
- **Refund Policy:** Donations are generally non refundable. If a perk is removed or edited refunds will not be given. - **Refund Policy:** Donations are generally non refundable. If a perk is removed or edited refunds will not be given.
- **Modification of Perks:** Perks may be modified at any time to change details about a perk, add new perks, or remove existing perks. They are privileges and do not constitute a legal right or entitlement. - **Modification of Perks:** Perks may be modified at any time to change details about a perk, add new perks, or remove existing perks. They are privileges and do not constitute a legal right or entitlement.
- **Perk Removal:** Users may have perks taken away from them if they abuse the perk (as in use it in a way it was not intended) or break our [Code of Conduct](https://github.com/programming-dot-dev/p.d-legal/blob/main/CODE-OF-CONDUCT.md). - **Perk Removal:** Users may have perks taken away from them if they abuse the perk (as in use it in a way it was not intended) or break our [Code of Conduct](https://github.com/programming-dot-dev/p.d-legal/blob/main/CODE-OF-CONDUCT.md).
## Do we Make Updates to this Donation Policy? ## Are Updates Made to this Donation Policy?
We may update the Donation Policy from time to time. When we do, we will change the "Last Updated" date and author at the top of the page to indicate the date and author of the most recent changes. If we make changes we may notify you by posting a notice of such changes or by sending you a notification. We encourage you to review this Donation Policy periodically for any modifications. We may update the Donation Policy from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes in our meta community on the programming.dev site, in the updates account on the bytes.programming.dev site, in our blog on the stacks.programming.dev site, in the news community in our discord server, and in the news community in our matrix server. We encourage you to review the Donation Policy periodically for any modifications.
## Contact Us ## Contact Us
If you have questions or concerns about this Donation Policy you should contact us at info@programming.dev. If you have questions or concerns about this Donation Policy you should contact us at info@programming.dev.

View File

@ -0,0 +1,8 @@
# Moderator Guidelines
These moderator guidelines detail expected conduct when moderating a community in one of the Programming.Dev ("programming.dev", "we", "us", "our") sites.
## Do we Make Updates to these Moderator Guidelines?
We may update the Moderator Guidelines from time to time. When we do the date at the bottom of the page will change to indicate the date of the most recent changes. In addition, clicking on that date will bring you to the commit in the code repository that shows who edited it, and what was changed. If we make changes we may notify you by posting a notice of such changes in our meta community on the programming.dev site, in the updates account on the bytes.programming.dev site, in the news community in our discord server, and in the news community in our matrix server. We encourage you to review the Moderator Guidelines periodically for any modifications.
## Contact Us
If you have questions or concerns about these Moderator Guidelines you should contact us at info@programming.dev.

View File

@ -0,0 +1,7 @@
---
BookMenuBundle: '/menu/test'
---
Test 2A
ASFASF
ASFAISHFIUASF

View File

@ -7,11 +7,13 @@ headless: true
- [🤖 Automation Guidelines]({{< relref "/docs/automation-guidelines" >}}) - [🤖 Automation Guidelines]({{< relref "/docs/automation-guidelines" >}})
- [🤝 Code of Conduct]({{< relref "/docs/code-of-conduct" >}}) - [🤝 Code of Conduct]({{< relref "/docs/code-of-conduct" >}})
- [🪴 Community Guidelines]({{< relref "/docs/community-guidelines" >}}) - [🪴 Community Guidelines]({{< relref "/docs/community-guidelines" >}})
- [🪲 Contributing Guidelines]({{< relref "/docs/contributing-guidelines" >}})
- [🍪 Cookie Policy]({{< relref "/docs/cookie-policy" >}}) - [🍪 Cookie Policy]({{< relref "/docs/cookie-policy" >}})
- [📘 Data Retention Policy]({{< relref "/docs/data-retention-policy" >}}) - [📘 Data Retention Policy]({{< relref "/docs/data-retention-policy" >}})
- [🖇️ Defederation Policy]({{< relref "/docs/defederation-policy" >}}) - [🌍 Defederation Policy]({{< relref "/docs/defederation-policy" >}})
- [❤️ Donation Policy]({{< relref "/docs/donation-policy" >}}) - [❤️ Donation Policy]({{< relref "/docs/donation-policy" >}})
- [🏡 Moderator Guidelines]({{< relref "/docs/moderator-guidelines" >}}) - [🏡 Moderator Guidelines]({{< relref "/docs/moderator-guidelines" >}})
- [🔒 Privacy Policy]({{< relref "/docs/privacy-policy" >}}) - [🔒 Privacy Policy]({{< relref "/docs/privacy-policy" >}})
- [📜 Terms of Service]({{< relref "/docs/terms-of-service" >}}) - [📜 Terms of Service]({{< relref "/docs/terms-of-service" >}})
- [A]({{< relref "/docs/test/test" >}})
<br/> <br/>

View File

@ -0,0 +1,14 @@
---
headless: true
---
**Documents**
- [🛠️ Admin Guidelines]({{< relref "/docs/privacy-policy" >}})
- [🤖 Automation Guidelines]({{< relref "/docs/automation-guidelines" >}})
- [🤝 Code of Conduct]({{< relref "/docs/code-of-conduct" >}})
- [🪴 Community Guidelines]({{< relref "/docs/community-guidelines" >}})
- [🪲 Contributing Guidelines]({{< relref "/docs/contributing-guidelines" >}})
- [🍪 Cookie Policy]({{< relref "/docs/cookie-policy" >}})
- [📘 Data Retention Policy]({{< relref "/docs/data-retention-policy" >}})
- [A]({{< relref "/docs/test/test" >}})
<br/>

View File

@ -26,3 +26,4 @@ params:
BookLogo: 'logo.png' BookLogo: 'logo.png'
BookFavicon: 'logo.png' BookFavicon: 'logo.png'
BookMenuBundle: /menu BookMenuBundle: /menu
BookRepo: https://github.com/programming-dot-dev/p.d-legal

View File

@ -0,0 +1,4 @@
{{ with .Site.GetPage .Page.Params.BookMenuBundle }}
{{- $href := printf "href=\"%s\"" $.RelPermalink -}}
{{- replace .Content $href (print $href "class=active") | safeHTML -}}
{{ end }}

View File

@ -0,0 +1,25 @@
<nav>
{{ partial "docs/brand" . }}
{{ partial "docs/search" . }}
{{ partial "docs/languages" . }}
{{ partial "docs/inject/menu-before" . }}
{{ partial "docs/menu-hugo" .Site.Menus.before }}
{{ if .Page.Params.BookMenuBundle }}
{{ partial "docs/menu-page-bundle" . }}
{{ else if .Site.Params.BookMenuBundle }}
{{ partial "docs/menu-bundle" . }}
{{ else }}
{{ partial "docs/menu-filetree" . }}
{{ end }}
{{ partial "docs/menu-hugo" .Site.Menus.after }}
{{ partial "docs/inject/menu-after" . }}
</nav>
<!-- Restore menu position as soon as possible to avoid flickering -->
{{ $script := resources.Get "menu-reset.js" | resources.Minify }}
{{ with $script.Content }}
<script>{{ . | safeJS }}</script>
{{ end }}

File diff suppressed because one or more lines are too long

View File

@ -1 +1 @@
{"Target":"book.min.be88099e095501d0b42a29e103f2e3c77f629430b25d08671f3f559cf78659f3.css","MediaType":"text/css","Data":{"Integrity":"sha256-vogJnglVAdC0KinhA/Ljx39ilDCyXQhnHz9VnPeGWfM="}} {"Target":"book.min.0beb2726d9ba157e98e2b24e91d69db40c1d53dfcc30016ea120564413e396a9.css","MediaType":"text/css","Data":{"Integrity":"sha256-C+snJtm6FX6Y4rJOkdadtAwdU9/MMAFuoSBWRBPjlqk="}}