Commit Graph

213 Commits

Author SHA1 Message Date
spiral
d17e93e8b0
add API libraries to docs 2021-07-13 23:06:51 -04:00
spiral
902bad110c
Add missing flags to docs 2021-07-08 10:34:13 -04:00
spiral
c727a71161
Add "flat" front history view (percentages add up to 100%) 2021-06-21 11:30:38 -04:00
spiral
28cd50a5bf
Clarify member/group argument in command list
Co-authored-by: Powi <powi@powi.fr>
2021-06-11 21:12:58 +00:00
spiral
ad551b983d
docs: update dependencies 2021-06-11 21:08:28 +00:00
spiral
0fa13f6e1e
Add note about #238 discussing privacy options 2021-06-09 07:24:24 +00:00
spiral
1fa2d9a093
Update documentation (#332)
Co-authored-by: Petal Rose <habonimkef@gmail.com>
2021-06-02 23:50:45 +00:00
spiral
0b91e71384
Merge pull request #293 from spiralw/feat/faq 2021-05-23 18:07:31 +02:00
spiral
de0713277a
Add Catalogger to PluralKit-compatible bots 2021-05-20 12:39:53 +01:00
spiral
828ddf8bce
Update faq.md 2021-05-12 23:54:03 +01:00
rladenson
0051ccf2fb
Update user-guide.md
It said that pk doesn't have some things that have since been implemented.
2021-05-08 01:10:32 -06:00
Mikaela Szekely
6395872f2d allow pk;system proxy to take a server ID
So people can disable proxying in a server without outing themselves :)
2021-05-06 10:19:15 -06:00
spiral
f120a592f0
add latest faq entry 2021-05-03 10:10:21 +01:00
spiral
dfa25b77c7
Add flag to remove 'no fronter' item on frontpercent card 2021-04-22 01:18:41 +01:00
spiral
4d86acafc3
Update FAQ 2021-03-22 11:41:50 +00:00
spiral
78c693f5ad
Add authorization header example 2021-01-09 16:59:28 +00:00
Ske
a328867e76 Ask for slash command permission in the invite links 2020-12-18 13:47:18 +01:00
Astrid
77d63c2838
Merge branch 'main' into feat/ap 2020-12-08 12:25:01 +01:00
Astrid
604ef1665a
Merge pull request #229 from dev-kittens/dark-docs
Use browser prefers-color-scheme for dark theme docs
2020-12-08 12:22:40 +01:00
spiral
e3274d5d26
Move member random to Random.cs, add group random and group member random 2020-11-22 11:58:23 -05:00
spiral
edb92168ea Add documentation on the website as well 2020-11-22 09:44:07 -05:00
spiral
68b439257d Tweak documentation 2020-11-22 09:42:40 -05:00
spiral
8e5fb6520b Add configurable autoproxy latch timeout 2020-11-22 09:42:40 -05:00
spiral
37294b68da Add disabling autoproxy per-account 2020-11-22 09:42:40 -05:00
spiral
41247c68a6 Add disabling front/latch autoproxy per-member 2020-11-22 09:42:40 -05:00
spiral
01cedaab53
Tweak description for switch delete all command 2020-11-19 18:05:53 -05:00
spiral
2858c68a7d
Clean up member list commands and log commands, as well as related docs 2020-11-19 17:10:59 -05:00
Ske
9a3e7273fb Add note about chat filter bots to docs 2020-11-15 15:15:08 +01:00
Astrid
90b2fcfdd4
Merge pull request #247 from dev-kittens/tweak/group-dn
Add looking up group by display name
2020-11-15 13:15:29 +01:00
spiral
09536b3903
Document avatar URL flag 2020-11-14 12:37:40 -05:00
spiral
71461b3163
Add looking up group by displayname; document this 2020-11-14 10:42:51 -05:00
Ske
20ca37938c Relicense project to AGPLv3 2020-11-08 18:52:36 +01:00
dev-kittens
8a747a6056 Use prefers-color-scheme for dark theme docs 2020-10-09 18:54:46 +00:00
dev-kittens
2a041d9eb5 Document group commands 2020-10-04 07:12:40 +00:00
dev-kittens
c50a9ea008 Add member list flags 2020-10-04 06:38:04 +00:00
Ske
7075c61756 Migrate to new Getting Started page from new-docs branch 2020-09-13 01:18:31 +02:00
kittens
32fe52c959
Add pronouns field in member model in API docs 2020-09-10 06:10:20 -04:00
Astrid
616e490e42
Merge pull request #212 from xSke/dependabot/npm_and_yarn/docs/prismjs-1.21.0
Bump prismjs from 1.20.0 to 1.21.0 in /docs
2020-08-21 18:33:19 +02:00
Ske
8688f4d0bf Merge branch 'main' into feature/groups 2020-08-21 18:31:49 +02:00
Ske
9e251352c7 Various fixes and improvements 2020-08-16 12:10:54 +02:00
dependabot[bot]
f984875145
Bump prismjs from 1.20.0 to 1.21.0 in /docs
Bumps [prismjs](https://github.com/PrismJS/prism) from 1.20.0 to 1.21.0.
- [Release notes](https://github.com/PrismJS/prism/releases)
- [Changelog](https://github.com/PrismJS/prism/blob/master/CHANGELOG.md)
- [Commits](https://github.com/PrismJS/prism/compare/v1.20.0...v1.21.0)

Signed-off-by: dependabot[bot] <support@github.com>
2020-08-08 00:44:15 +00:00
acw0
4006d353f2 fix formatting 2020-07-29 11:30:46 +02:00
acw0
2dee8ab1ae Document external emoji permissions 2020-07-29 11:30:46 +02:00
Ske
2d755edc89 Expand on FAQ with content from the support server 2020-07-28 23:16:41 +02:00
Ske
80fe6729cb Expand on documentation aimed at server staff 2020-07-28 23:13:32 +02:00
Ske
93e4275b97 Fix the edit link on the docs 2020-07-28 20:11:45 +02:00
Ske
9fc042eddf Remove commented-out hero front matter 2020-07-28 20:11:34 +02:00
Ske
0fd56d83e1 Document removal of unversioned API endpoints 2020-07-28 20:01:30 +02:00
Ske
0fadc81cda Minor layout/content tweaks 2020-07-28 18:47:26 +02:00
Ske
8c0cbd6d26 Migrate docs to Vuepress 2020-07-28 18:19:40 +02:00
Ske
3e2f20fc04 Use standard Gem-style theme references 2020-06-22 14:43:46 +02:00
Ske
9eb982c762 Commit bundle config and lockfile 2020-06-22 14:34:59 +02:00
Ske
ae4e8f97d0 Add member avatar privacy 2020-06-20 16:00:50 +02:00
Ske
78f83339ae Update reference to OpenAPI specification 2020-06-17 22:13:01 +02:00
Ske
327cd0aafd Update documentation for privacy changes 2020-06-17 21:55:39 +02:00
BeeFox-sys
721a4502bb
Feature/granular member privacy (#174)
* Some reasons this needs to exist for it to run on my machine? I don't think it would hurt to have it in other machines so

* Add options to member model

* Add Privacy to member embed

* Added member privacy display list

* Update database settings

* apparetnly this is nolonger needed?

* Fix sql call

* Fix more sql errors

* Added in settings control

* Add all subject to system privacy

* Basic API Privacy

* Name privacy in logs

* update todo

* remove CheckReadMemberPermission

* Added name privacy to log embed

* update todo

* Update todo

* Update api to handle privacy

* update todo

* Update systemlist full to respect privacy (as well as system list)

* include colour as option for member privacy subject

* move todo file (why was it there?)

* Update TODO.md

* Update TODO.md

* Update TODO.md

* Deleted to create pr

* Update command usage and add to the command tree

* Make api respect created privacy

* Add editing privacy through the api

* Fix pronoun privacy field in api

* Fix info leak of display name in api

* deprecate privacy field in api

* Deprecate privacy diffrently

* Update API

* Update documentation

* Update documentation

* Remove comment in yml

* Update userguide

* Update migration (fix typo in 5.sql too)

* Sanatize names

* some full stops

* Fix after merge

* update migration

* update schema version

* update edit command

* update privacy filter

* fix a dumb mistake

* clarify on what name privacy does

* make it easier on someone else

* Update docs

* Comment out unused code

* Add aliases for `member privacy all public` and `member privacy all private`
2020-06-17 21:31:39 +02:00
ariel w
82886fe9e2
Move discord links to new domain (#180) 2020-06-11 21:12:43 +02:00
Ske
38e65b3971 Properly publish OpenAPI spec 2020-05-07 01:36:00 +02:00
Ske
e9cc0c8fdf Fix wrong delete command in privacy docs. Closes #168. 2020-05-03 00:37:04 +02:00
Ske
884d6e1925 Add pk;find to the command list 2020-03-05 19:08:11 +01:00
Ske
628ae6beb7 Update command list documentation 2020-03-04 18:28:13 +01:00
Ske
55671b45d6 Add support for UnbelievaBoat 2020-02-15 14:17:25 +01:00
Ske
ccf81b0826 Add support for Pancake 2020-02-15 14:17:25 +01:00
Ske
e9cc8ed424 Add logger bot cleanup support 2020-02-15 14:17:25 +01:00
Ske
bef3f5c79a Merge branch 'api-privacy' of https://github.com/greysdawn/PluralKit into greysdawn-api-privacy 2020-02-13 22:55:10 +01:00
Ske
d0d3579b17 Add server-specific member avatars 2020-02-12 17:42:12 +01:00
xgreyskiesx
af344bb77c Add privacy set/get to API 2020-02-10 05:33:43 -05:00
Ske
30ed293dc6 Change no-year sentinel value to 0004
This allows setting the date "Feb 29" with no year, since the year 0004 is a leap year in the Gregorian calendar, while the year 0001 isn't.
2020-02-09 22:36:02 +01:00
Ske
f2bbf8a51d Tweaks to the new documentation 2020-02-09 15:08:37 +01:00
BeeFox-sys
9e47f98a23
Improve Docs (#151)
* Added configurable command prefix

* Added getting started, renamed files

* Add nav order, add assests, add system example

* Added a lot

* Update Emojis

* Add guide links to bot

* Added Images
2020-02-09 14:17:26 +01:00
Ske
ab39ebc512 Document Content-Type requirement for API 2020-02-03 14:47:08 +01:00
Ske
2abb9fc9f9 Fix API schema tables 2020-01-31 12:56:21 +01:00
Ske
8e1b3dfa98 Add privacy section to user guide 2020-01-30 09:52:28 +01:00
Ske
0ce5883da1 Add command list documentation for missing commands 2020-01-25 16:46:34 +01:00
Astrid
eb44c8fda2
Merge pull request #150 from xSke/feature/autoproxy
Implement autoproxy. Closes #149.
2020-01-25 16:35:31 +01:00
Ske
01c4e99876 Document autoproxy functionality 2020-01-25 16:21:52 +01:00
Ske
4922181fe1 Explicitly state information privacy in the privacy policy 2020-01-23 22:14:32 +01:00
Ske
98613c4287 Add system and member privacy support 2020-01-11 16:51:13 +01:00
Ske
5835ab63cd Update API documentation with new serialisation changes 2019-12-28 16:12:16 +01:00
Ske
468241c92f Add avatar preview with no arguments 2019-12-28 12:23:52 +01:00
Ske
8e1b27e5fd Add website documentation for servername 2019-12-27 11:43:18 +01:00
Ske
d2205ea7e6 Update documentation with new features 2019-12-22 14:26:53 +01:00
Ske
7db55a3992 Update API documentation examples to align with updated schema 2019-11-03 19:20:41 +01:00
Ske
7c3b4b9af9 Add command to delete all switches 2019-11-02 22:46:51 +01:00
Ske
1e1f2acdc3 Document latest API changes 2019-11-02 22:37:56 +01:00
Ske
9211ce0e7f Add documentation for keepproxy feature 2019-10-30 13:59:22 +01:00
Ske
393ee16c1b Add support for multiple proxy tags
Tangentially closes #103.
2019-10-30 08:18:59 +01:00
Ske
284e8eb95a Include underscore properly in display_name API docs 2019-10-18 13:38:25 +02:00
Astrid
af4da8fd72
Merge branch 'master' into patch-2 2019-10-18 13:37:09 +02:00
Ske
7d1accd58d Fix file name of tips and tricks page 2019-08-31 19:13:37 +02:00
Ske
1bfdb43c1f Fix message model table 2019-08-31 19:13:10 +02:00
Ske
dbade9b6bc Various minor site/documentation changes 2019-08-31 12:32:28 +02:00
Grey Himmel
1596694686
Document member display names 2019-08-09 11:40:58 -04:00
Grey Himmel
f2a71a333b Document member DELETE route
Add API documentation to the new DELETE route for members
2019-08-09 12:55:40 +02:00
Bella | Nightshade
9f2faeea5a Escape markdown in proxy tags on member card (#118)
* Fix a typo

* Escape markdown in proxy tags on member card

* Whoops hhh

Added API documentation for POST to member endpoint
2019-08-09 12:55:15 +02:00
Ske
7d6c8d46cb Add display names to documentation 2019-08-09 10:34:41 +02:00
xBelladonna
2217b87afe Fix typo in docs 2019-07-27 12:56:35 +02:00
Ske
24ea11f691 Add docs page for permission check command 2019-07-26 12:18:23 +02:00
Ske
961bfe9094 Add basic logging framework 2019-07-18 17:13:42 +02:00
Ske
ca73a215c8 Add endpoint for querying messages by ID 2019-07-17 14:05:44 +02:00
Ske
e28ed585ce Add endpoint for querying systems by Discord snowflake 2019-07-17 13:45:52 +02:00
Ske
f5b6ce4587 Exclude index page from nav 2019-07-16 00:57:30 +02:00
Ske
27dc88db11 Fix API documentation tables finally 2019-07-16 00:36:28 +02:00
Ske
073aff82f1 Add better website front page 2019-07-16 00:34:37 +02:00
Ske
6f082de40e Render API endpoint headers in normal font 2019-07-15 22:28:55 +02:00
Ske
8e592eea13 Attempt to fix table rendering on API docs 2019-07-15 22:26:48 +02:00
Ske
b2ec1b6079 Add docs page describing command aliases 2019-07-15 22:16:43 +02:00
Ske
39152dbd27 Add an endpoint to view your own system 2019-07-15 20:06:28 +02:00
Ske
eb749d0c37 Fix typo in command list 2019-07-15 17:37:34 +02:00
Astrid
0c97611c41 Create CNAME 2019-07-15 16:18:15 +02:00
Ske
2b508f80e9 Add API documentation to docs 2019-07-10 13:20:57 +02:00
Ske
ab49ad7217 Add command list and API documentation 2019-07-03 11:44:57 +02:00
Ske
f4b0607572 Add basic documentation site 2019-07-03 10:25:24 +02:00