#Contributing to TTS API documentation

1 messages · Page 1 of 1 (latest)

astral chasm
#

@quartz ingot pinging you in here to keep this out of the main channel.
I've been following the instructions from the github repo (https://github.com/Berserk-Games/Tabletop-Simulator-API/).
The final command mkdocs serve is running into an error though.
Can you confirm whether these instructions are still correct (e.g. working for you) or if I am doing something wrong?
(While I'd appreciate it, I don't need you to debug this for me, just want to know whether I am going in the right direction.)

image.png
quartz ingot
#

@shut gorge would be better suited to answer but it seems like you're missing or have a broken install of setuptools

#

pip install setuptools probably

#

I seldom use python (bun/node for me >:) )

astral chasm
#

I'll wait for b_d

astral chasm
#

Friend recommended me to try uv and that seems to properly install the dependancies, but now I am missing some emojis? LOL

image.png
astral chasm
#

Further diving into it, it seems like some of the dependancies are no longer available

#

Looks like the project might need a small update to allow contributing 😅

quartz ingot
#

I'd have preferred to use something flatfile but this was added before I had a say so e: actually mkdocs is flatfile

shut gorge
#

ngl, I couldn't get it to work either.

I've upgraded Python, the dependencies, Github Actions and the documentation. It's now in working order again.

astral chasm
astral chasm
#

works for me too now

#

Great job

astral chasm
quartz ingot
#

alright give me a minute to juggle password managers that log me out

astral chasm
#

Hah no rush

astral chasm
quartz ingot
# astral chasm Hah no rush

can you maybe rename that to actually be semantically understandable i.e "set selection to dropdown menu item at index" or something like that

image.png
astral chasm
quartz ingot
#

comments in docs should be very literally what it does not what it's higher up purpose is 😆

astral chasm
#

To elaborate, this is necessary to make sure the dropdown selection stays the same when using getXmlTable() & editing & setXmlTable() down the line

shut gorge
#

Haha, I had similar feedback, but on a different line.

astral chasm
#

Updated it with better wording

astral chasm
shut gorge
#

All good. Was a super straight forward review. Much appreciated.

astral chasm
astral chasm
#

@quartz ingot I've reviewed most of the open PRs on the API repository, they look good to me

quartz ingot
astral chasm
#

@quartz ingot let me know if I can do anything to get my PR (and the other ones) over the finish line

quartz ingot
#

@shut gorge can you look these over?

astral chasm
#

@quartz ingot Sorry for the weekly ping, but if benjamin isn't available, could you review the PRs?

quartz ingot
#

no worries about the ping but it's too late right now I'll check tomorrow morning or when I get back in the evening
e: postponing until tomorrow feeling a bit off today so not working

astral chasm
#

Totally fine by me, it ain't urgent

quartz ingot
#

alright checking now

#

aaaaaaaah my eyes my other account doesn't have dark mode enabled

#

Looked fine to me all merged

astral chasm
astral chasm
quartz ingot
#

Haha my bad, I'll look over it closelier tomorrow but I think your example here is missing an end

image.png
astral chasm
#

was just a test

quartz ingot
#

it's also maybe not the best example sa getobjects expects to be used on a container

#

as*

astral chasm
#

That's not correct

quartz ingot
#

getAllObjects()?

astral chasm
#

getObjects() exists as both a Global function and a container function

astral chasm
quartz ingot
#

really, I use it all the time l0l

astral chasm
quartz ingot
#

thought they were distinctly different but oki thanks

#

I'll look it over tomorrow

astral chasm
quartz ingot
#

looking now

#

what does !!! in markdown do

#

merged

#

and merged a few other basic ones

#

thanks