!QtykxKocfZaZOUrTwp:matrix.org

Matrix HQ

2037 Members
The Official Matrix HQ - please come chat here! | Room reborn 2018-06-11 to flush ancient state | To support Matrix.org development: https://patreon.com/matrixdotorg | Looking for hosting? Check out https://upcloud.com/matrix!338 Servers

Load older messages


Timestamp Message
25 Sep 2018
13:58:09@freenode_goddess:matrix.orggoddess (IRC) left the room.
14:03:07@freenode_Willy:matrix.orgWilly (IRC) joined the room.
14:09:43@freenode_Willy:matrix.orgWilly (IRC) left the room.
14:12:07@Half-Shot:half-shot.ukHalf-ShotI'll ask in here because there are a lot of heads: Anybody got any suggestions for tools/languages/things for writing a protocol spec on. I'm currently writing it in google docs but it's a bit crap for a lot of reasons.
14:12:51@Half-Shot:half-shot.ukHalf-ShotI could markdown, but it's not all that smart. The other option is swagger, but it seems geared towards strictly http protocols.
14:16:36@Coffee:matrix.orgCoffee What would you need that markdown doesn't have?
14:16:56@mujx:matrix.orgmujxHalf-Shot: what problems are you facing with the current solutions?
14:22:07@trilobite17:matrix.orgtrilobite17<dd> and <dt> ... or is it the other way around?
14:22:15@ghost:5.196.71.125Puss Half-Shot: VIM 😉
14:22:39@trilobite17:matrix.orgtrilobite17or is one of them <dl> even?
14:23:06@Half-Shot:half-shot.ukHalf-Shot mujx: When trying to respond to you, it hit me that my painpoints with google docs is the formatting and having the concept of pages means everything gets split up. The tables are also kinda ugly and formatting code is just taking a long time because docs tries to autocorrect my grammar, and I have to keep formatting it by hand.
14:23:35@Half-Shot:half-shot.ukHalf-ShotActually thinking about it, I might just write a swagger generated doc for the rest portion of my protocol and a regular markdown/rst doc for the websocket component
14:23:48@mujx:matrix.orgmujxyea google docs are not really suited for technical writing
14:24:01@ghost:5.196.71.125PussYou are writting a documentation ?
14:24:19@ghost:5.196.71.125Pussaka something that need formatting and not code ?
14:24:38@Half-Shot:half-shot.ukHalf-Shot Puss: I'm documenting the protocol used for my IRC connection holding service, because documenting protocols makes for happier developers.
14:24:48@loonycyborg:matrix.orgloonycyborgI think markdown written with plain text editor is the less hassle free way atm
14:24:48@Half-Shot:half-shot.ukHalf-Shot
In reply to @ghost:5.196.71.125
aka something that need formatting and not code ?
Yep
14:24:58@loonycyborg:matrix.orgloonycyborg*least
14:25:33@ghost:5.196.71.125PussWell, if you want to learn Latex is the best way (it's a really advanced PDF editor) Otherwise for something simple markdown might do the job
14:25:58@ghost:5.196.71.125PussLateX*
14:26:33@gmosis:matrix.orggmosis

I'll ask in here because there are a lot of heads: Anybody got any suggestions for tools/languages/things for writing a protocol spec on. I'm currently writing it in google docs but it's a bit crap for a lot of reasons.

Latex

14:26:48@Half-Shot:half-shot.ukHalf-Shot
In reply to @loonycyborg:matrix.org
I think markdown written with plain text editor is the less hassle free way atm
99% of my technical notes I write are markdown :D
14:27:00@Half-Shot:half-shot.ukHalf-ShotLateX is actually not a bad shout
14:27:06@mujx:matrix.orgmujxor use whatever IETF uses to generate the RFCs :P
14:27:23@Half-Shot:half-shot.ukHalf-Shot I've not used it in a couple of years, how hard can it be
14:27:26@ghost:5.196.71.125PussYou might like that too https://readthedocs.org/ (Example of documentation made with it : https://beets.readthedocs.io )
14:27:29@Half-Shot:half-shot.ukHalf-Shot
In reply to @mujx:matrix.org
or use whatever IETF uses to generate the RFCs :P
Claws eyes out
14:27:41@gmosis:matrix.orggmosisNotepad++
14:34:20@freenode_lqi:matrix.orglqi (IRC) joined the room.

There are no newer messages yet.


Back to Room List