#📜-doccer

1 messages · Page 1 of 1 (latest)

rough tartan
#

time to go recruit the MASSES

rugged vale
#

so poggie

gaunt kestrel
#

wtf is this

rough tartan
#

documentation writing

#

its a very extended joke

#

jetbrains writerside being their IDE for.. writing documentation

#

i think im very funny

#

i just wanted a place to organise it properly

olive rover
#

no members ?

image.png
rough tartan
#

bug

#

hello writerside users, here's the drill

all docs are hosted on vencord.dev and are currently on the feat/docs branch.

all documentation content is put in src/content/docs, written in markdown (take a look at the existing stuff for how to format)

documentation categories can be made by making a small json file in src/content/docCategories if you need, but try to use the existing ones if possible (ask if you aren't sure if something fits!)

open a PR (making sure the base is feat/docs) with your contributions (when merged, this will be different)

rough tartan
gaunt kestrel
#

we should properly plan it first

#

plan what the different categories and topics will be

rough tartan
#

ye that's why i want people to ask about it

#

cuz it opens up for discussion

#

time to write docs for.. contributing to docs!

thin maple
#

plink.mp4

rough tartan
#

github issues

#

if you have it locally just work locally for now

thin maple
#

yeah i do :p

#

i have an issue where /plugins isnt working/isnt being built by astro

#

is this something to worry about or

rough tartan
#

that's fine

#

it's pulled from github

#

@thin maple

#

it should work fine now

thin maple
rough tartan
#

ah well

#

ignore

thin maple
#

alright :3

rough tartan
#

@wide scroll

cursive hare
#

wait are we actually using writerside for vc

#

lmfao

rough tartan
#

nah lmfao

#

just a funny name

#

long winded joke about funny minor jetbrains ides

rough tartan
#

o yeah @thin maple what page were you writing?

#

history has been made

image.png
warm fossil
#

hi

rough tartan
#

welcome to the club

#

write docs

warm fossil
#

why do mods not have access

rough tartan
#

cuz it was for just the docwriters

#

and we have so little people here it didnt really need mod

thin maple
rough tartan
#

dw

#

activity isnt a mandatory thing

#

you can write whenever and however much you want

#

no matter how little the contribution i value it a ton

olive rover
#

has anyone done docs for native plugins

rough tartan
#

not yet, they're brand new

olive rover
#

if not i might do that tonight

#

oki

rough tartan
#

rember to PR to feat/docs

olive rover
#

oki

#

on vendicated/vencord or another repo

rough tartan
#

vencord/vencord.dev

#

when we get a couple of good pages down i'll write a work in progress notice and publish it to the main site

olive rover
#

ty

rough tartan
#

i will write some pages soon

#

just been really busy, sorry

cursive hare
#

should this be moved to wiki

warm fossil
#

jetbrains writerside

gaunt kestrel
#

real?

real thistle
#

erm

gaunt kestrel
real thistle
#

these are some great docs

gaunt kestrel
#

horror splash

real thistle
#

dinosaur ❤️

#

dinsor

flint juniperBOT
gaunt kestrel
#

okay so

#

soon I will create all the markdown files i think will be necessary

#

if anyone wants to contribute, just pick a section and pr 🙏🏻

but please only if you really know what you're talking about

#

and if you want anything specific covered, just lemme know

#

(it's still very WIP for now)

flint juniperBOT
lavish trail
twin burrow
#

why did we go with docusarus

#

it's not bad but I'm not fond of it and I feel there's better options

gaunt kestrel
#

because there's no point infinitely bikeshedding

#

it's easy to switch, just need to get started and just do it

lavish trail
#

buttons get cut off on smaller viewports

#

uncropped for clarity

Screenshot_20240624-131306.jpg
gaunt kestrel
#

okay we switching to starlight

rough tartan
#

jetbrains writerside

twin burrow
#

I was up to helping with anything vitepress related

flint juniperBOT
gaunt kestrel
#

@rough tartan 🌠

rough tartan
#

looks good actually

#

definitely better than the last time

gaunt kestrel
#

search works out of the box

image.png
wide scroll
gaunt kestrel
#

does it not have

lavish trail
#

i was gonna ask why you weren't using starlight earlier given you use astro everywhere else

gaunt kestrel
wide scroll
#

oh nvm

#

didnt realize it doesn't show up on homepage

lavish trail
gaunt kestrel
jagged kraken
rough tartan
# 
/**
 * Translates a key. Soft-fails and returns the key if it is not valid.
 * @param key The key to translate.
 * @param variables The variables to interpolate into the resultant string. If dealing with plurals, `count` must be set.
 * @returns A translated string.
 */
lavish trail
#

theres a starlight plugin for localization

rough tartan
#

mmm yummy

lavish trail
rough tartan
#

im not localising the docs

#

yet

lavish trail
#

nvm it was just a vscode extension

gaunt kestrel
#

why would we localise docs

#

all programmers should be good at english

#

no point localising developer docs

rough tartan
#

i wanna localise the mod but a certain somebody wishes to pack me into an archive literally invented by the devil

#

(i still dont know what we're packing into them)

gaunt kestrel
#

vencord files & translations

rough tartan
#

which files

#

the ones in the data dir?

#

wait no

#

uh

#

the

#

vencord.js and whatnot

gaunt kestrel
# 
vencord.asar/
    vencord/
        renderer.js
        renderer.js.map
        main.js
        main.js.map
        preload.js
        preload.js.map
    vendor/
        monaco/
            ...
        other-dependency/
            explode.js
    locales/
        en.json
        de.json
rough tartan
#

I See

#

so the bit that gets injected will just be a loader

#

and it'll read the files from the archive

#

hey thats exactly how my client mod was gonna work ages ago!

gaunt kestrel
#

anyway about the docs

i don't particularly like the default theme but i'm unsure yet which theme to use for the docs site. i don't think we should use the same theme as the vencord.dev site

you can easily create themes here, maybe someone wants to come up with smth and propose it: https://starlight.astro.build/guides/css-and-tailwind/#theming

Starlight
CSS & Styling

Learn how to style your Starlight site with custom CSS or integrate with Tailwind CSS.

rough tartan
#

also Hark! Single Files For Locales

#

locales/en/vencord.json blobcatcozy

rough tartan
flint juniperBOT
gaunt kestrel
#

i cooked trust

flint juniperBOT
gaunt kestrel
#

peep

#

i dont really like the codeblocks

#

i think we can change them

jagged kraken
# 
/* Dark mode colors. */
:root {
    --sl-color-accent-low: #4b134f;
    --sl-color-accent: #dd34ff;
    --sl-color-accent-high: #d5add0;
    --sl-color-white: #e4c5e6;
    --sl-color-gray-1: #dccae5;
    --sl-color-gray-2: #c2b2c9;
    --sl-color-gray-3: #6b6271;
    --sl-color-gray-4: #48404b;
    --sl-color-gray-5: #403944;
    --sl-color-gray-6: #2a272c;
    --sl-color-black: #181619;
}
/* Light mode colors. */
:root[data-theme='light'] {
    --sl-color-accent-low: #ffc7ee;
    --sl-color-accent: #906186;
    --sl-color-accent-high: #721875;
    --sl-color-white: #17181c;
    --sl-color-gray-1: #24272f;
    --sl-color-gray-2: #353841;
    --sl-color-gray-3: #545861;
    --sl-color-gray-4: #888b96;
    --sl-color-gray-5: #c0c2c7;
    --sl-color-gray-6: #eceef2;
    --sl-color-gray-7: #eae3ea;
    --sl-color-black: #ebebeb;
}```


I tried
gaunt kestrel
#

thats also nice

#

idk which one is better

#

we will simply provide 3 million theme options

gaunt kestrel
jagged kraken
#

possibly have cards that act like a brief summary on what the documentation is gonna cover regarding developing for and with vencord

#

then the introduction would have more detailed information on that, possibly

#

just as repeatable bullet points as not everyone reads the cards on the front page

lavish trail
#

yeah i assumed there would be a card for each category

#

similar to gh docs

flint juniperBOT
flint juniperBOT
quartz oracle
#

whats this

#

if this is For Real New Docs™️

#

ADD A GIT BRANCHES GUIDE

gaunt kestrel
#

oh i can use tabs for docs

#

fire

flint juniperBOT
stone sluice
flint juniperBOT
round junco
#

im gonna write creating plugins

gaunt kestrel
round junco
#

oh ok

gaunt kestrel
round junco
#

i'll base these docs off of that then

fading hamlet
twin burrow
round junco
quartz ingot
#

docer

opal yew
#

doccer cmpose

thin maple
#

writerside

flint juniperBOT
gaunt kestrel
#

@round junco

#

this codeblock text highlighting is really neat

image.png
flint juniperBOT
flint juniperBOT
round junco
gaunt kestrel
round junco
#

Cool

flint juniperBOT
gaunt kestrel
#

saving the planet by using starlight docs ✨

image.png
shell jetty
#

lmao what

flint juniperBOT
flint juniperBOT
distant laurel
ivory jackal
#

not the doccers man

dry owl
spiral merlin
gaunt kestrel
#

they alr have comparable features

flint juniperBOT
meager gulch
#

i love how ios sucks ass
github don't work on webkit
vencor docs don't work on webkit
half the sites fkn break on webshit
so much for doing more than discord/media watching on ipad

#

my brother in shig

IMG_0844.png
floral tide
#

Tim cook logic

#

garbage

jagged kraken
#

it’s mainly due to low versions, you’re just always stuck with old software (including webkit)

#

not sure how apple makes their browsers so obsolete and unusable when it comes to 2-3 year old updates

floral tide
#

I still want an iPad again

#

and an ipod touch (and nano) 7th gen

#

and an ipod nano 6th gen (it's like a watch)

fading hamlet
#

(probably not)

lavish trail
#

wikis are a different thing

fading hamlet
#

well they are meant to be edited live

#

but other than that are they much different

lavish trail
#

yeah

#

the only similarities are that they display information (optionally done collaboratively)

spiral merlin
twin burrow
#

the comparison table doesn't really matter or atleast, make sense, as majority of starlight users have used astro before and will definitely bundle in their own tools, thus increasing that

quartz ingot
wide scroll
#

yes

flint juniperBOT
flint juniperBOT
olive rover
#

??????

jagged kraken
#

in.. dist?

flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
ivory jackal
#

@gaunt kestrel you can put “Closes #pr-number” in the commit message to automatically close it

gaunt kestrel
#

yes but only if you have perms to close

ivory jackal
#

what?

#

as soon as the commit gets into master it gets closed afaik, doesn’t matter what perms the user has

gaunt kestrel
#

yes

#

but then it's not u pushing it

#

someone else with perms pushing it

ivory jackal
#

fear

flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
glass gull
flint juniperBOT
quartz oracle
flint juniperBOT
flint juniperBOT
rain sinew
#

😔

stone sluice
flint juniperBOT
flint juniperBOT
twin burrow
#

did a review, hope thats ok

gaunt kestrel
#

why docker

flint juniperBOT
twin burrow
dim epoch
#

why is this in the files

image.png
#

😭

stone sluice
opal yew
#

is there anything for explaining how patches work planned

rugged vale
#

like the nerd stuff behind it or just how to write patches

opal yew
rugged vale
#

yeah how they actually modify stuff

dawn spruce
#

i still haven't managed to write a successful patch

flint juniperBOT
proven badger
# opal yew how to write them by the nerd stuff, im assuming you mean how they work

There used to be documentation on this on the repo but it was (re)moved:
https://github.com/Vendicated/Vencord/blob/0d5e2d0696da494aee2126b4cadbca7e07066b89/CONTRIBUTING.md#contributing-a-plugin
https://github.com/Vendicated/Vencord/blob/0d5e2d0696da494aee2126b4cadbca7e07066b89/docs/2_PLUGINS.md#making-your-patch

GitHub
Vencord/CONTRIBUTING.md at 0d5e2d0696da494aee2126b4cadbca7e07066b89...

The cutest Discord client mod. Contribute to Vendicated/Vencord development by creating an account on GitHub.

GitHub
Vencord/docs/2_PLUGINS.md at 0d5e2d0696da494aee2126b4cadbca7e07066b...

The cutest Discord client mod. Contribute to Vendicated/Vencord development by creating an account on GitHub.

flint juniperBOT
flint juniperBOT
#
MiguVT
[Vencord/Docs] Pull request opened: #12 Add Plugin Submission Documentation

This PR adds a comprehensive guide to the Vencord documentation, detailing how users can submit plugins for official inclusion. The guide includes:

  • Steps to fork and clone the Vencord repository.
  • Instructions on adding a plugin to the src/plugins directory.
  • How to commit changes and create a pull request.
  • An overview of the review process and how to respond to feedback.
  • Information about licensing and crediting plugin authors.

This guide aims to streamline the plugin sub...

flint juniperBOT
gaunt kestrel
#

why are people who never contributed in their life trying to write docs

flint juniperBOT
twilit kayak
flint juniperBOT
gaunt kestrel
#

😭

flint juniperBOT
olive rover
#

bro

flint juniperBOT
flint juniperBOT
opal yew
#

guhhhhhhh someone should make native.ts docs

#

too lazy to read other plugins

dim epoch
flint juniperBOT
gaunt kestrel
twilit kayak
flint juniperBOT
stone sluice
quartz oracle
#

i just had a huge look at it

flint juniperBOT
flint juniperBOT
quartz oracle
#

?remindme 7pm .

noble oasisBOT
#

Alright @quartz oracle, in 7 hours, 7 minutes and 2 seconds: …

noble oasisBOT
#

@quartz oracle, <t:1725839578:R>: …

flint juniperBOT
flint juniperBOT
flint juniperBOT
stone sluice
rigid hamlet
#

notepad++ always on top 🔥

quartz oracle
#

the docs should really specify installation for userplugins that are from a git repository

flint juniperBOT
gray mural
#

Notepad is a built in code editor atp

flint juniperBOT
flint juniperBOT
stone sluice
# flint juniper

I mean, I understand if something’s got a lot of PR(s) not being able to search every single one for something that already does that but there’s like four active ones its not that difficult to search

quartz oracle
stone sluice
quartz oracle
flint juniperBOT
gaunt kestrel
#

this is like the 4th pr like this

flint juniperBOT
twilit kayak
quartz oracle
#

can someone just accept one of the PRs

#

ngl new doccer so bad because of how unmaintained it is

#

<---- does not want to fix it knowing that if I do the PR will most-likely sit for 3 months

rugged vale
lavish trail
#

docs are literally just markdown files yet nothing is done

quartz oracle
#

we need docs that are more like a wiki

#

there is the "client mod wiki"

#

but idk if thats the right place to do it all

opal yew
#

docs: ghost ping vee five times in plugin-dev

quartz oracle
quartz oracle
# quartz oracle we need docs that are more like a wiki

i never did elaborate on what i mean by this
when I say "more like a wiki" i mean easily editable, having to PR documentation kinda sucks
the "quick edit and it's done" approach is very nice
also user pages on wikis could be a good place for niche guides that might not be fully accepted by the community

lavish trail
#

the problem is that good documentation needs to be reviewed for accuracy

#

we don't have thousands of nerds watching every change looking for errors or vandalism

flint juniperBOT
gaunt kestrel
#

just make pr

#

we don't need low effort drive-by contributions

#

we need people with experience making plugins writing the docs that actually matter

#

most topics need no docs

#

since most things should be fairly self explanatory if u just read

#

instead, we need to cover specific topics like

  • how to find modules efficiently
  • how webpack finds work
  • how to write patches
  • how to run native code with native.ts file
quartz oracle
#

we had docs for patches which where never transferred over

opal yew
quartz oracle
#

true, but they were better than nothing

gray mural
#

Patch guide?

#

Well needed

#

🙏

flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
glass gull
#

why though

flint juniperBOT
twilit kayak
#

four forks for a single line change

flint juniperBOT
flint juniperBOT
waxen tide
#

This PR should either be merged or closed IMO.
Thats how... pull requests work

#

like just wait for reviews, damn

late stump
#

am i stupid or are the docs surprisingly empty

lavish trail
#

its because theres not much that can be reasonably documented

#

most of the work is in figuring out discords code, which we can't document

gaunt kestrel
#

and cause no one wrote docs blobcatcozy

twilit kayak
#

ive been wanting to write docs for some time

#

but i never get around to doing it :blbocatcozy:

flint juniperBOT
gray mural
#

Did he js make the exact same PR as the one he closed?

twin trench
gray mural
#

Ic

waxen tide
#

it literally does requires nothing for you to keep a PR open other than to keep the fork

flint juniperBOT
gusty spindle
twilit kayak
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
hasty osprey
kindred geyser
#

idk

twilit kayak
hasty osprey
#

im dumb

#

i didint have it

#

😭

flint juniperBOT
flint juniperBOT
flint juniperBOT
twilit kayak
#

i will vibe code your death @gaunt kestrel

flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
flint juniperBOT
twilit kayak
#

i forgot i had a docs pr open

#

i should finish

golden holly
#

docker

silver mountain
#

i thought this was a channel for docker at first

#

bros wanna be discord userdoccers 😭 😂✌️

twilit kayak
#

userdockers

gaunt kestrel
#

podman >>>

flint juniperBOT
edgy elbow
#

I thought this channel was for docker

#

Not that I care but it’s funny 😂

flint juniperBOT
silver mountain
#

please merge i beg you
main repo pr backlog rot has reached even docs

gaunt kestrel
#

if anything it should be on all pages

silver mountain
#

isnt that gonna be a little excessive

#

actually nah

#

one sec

silver mountain
#

ok added just for the first 3 pages though, cus imo any more and it starts looking unnecessary/you already need vc cloned

Merge

silver mountain
#

happy 2 months

summer hazel
#

Vencord docs never getting finished btw

#

Might as well delete this channel and the repo

gaunt kestrel
#

u could work on it instead of being annoying

summer hazel
#

?remind 3:30pm

noble oasisBOT
#

Alright @summer hazel, in 18 hours, 4 minutes and 27 seconds: …

gaunt kestrel
#

😭

#

I should make a draft of what topics would be useful to cover

noble oasisBOT
#

@summer hazel, <t:1776054333:R>: …

gritty zenith
#

@summer hazel get to work

summer hazel
#

okay.

summer hazel
#

if you give me a list of things to do ill do them

silver mountain
#

@gaunt kestrel @gaunt kestrel

bitter igloo
#

@gaunt kestrel

restive kayak
reef sparrow
#

i wanna write something about natives tbh

#

i'm always the one yelling at equicord plugin devs to properly do native

silver mountain
#

get to it then mate

meager gulch
meager gulch
flint juniperBOT
silver mountain
#

isnt the current plugin submission "guide" just
look at other "new plugin" prs

gritty zenith
#

this guys beating a dead horse broken_love

#

jokes aside yeah its super empty, but I would just close this and say just pr changes
I dont think submission really needs anything apart from git knowledge