Documentation, build improvements #1

tasiaiso · 2024-02-19T13:34:20-05:00

tasiaiso commented

2024-02-19 13:34:20 -05:00

doc: add JSDoc annotations and documentation to the core folder
chore: add folders to .gitignore
build: change CodeMirror's settings (I want feedback on this before merging) and add a build script

Cory, can you follow @cAZLe85daCHL1WFNpa/6xnp7KJn/7hg1iL2y3qQaBbY=.ed25519 ? This is my laptop's TF feed. Manyverse is acting up on my phone so I can't use my main feed right now.

doc: add JSDoc annotations and documentation to the `core` folder chore: add folders to .gitignore build: change CodeMirror's settings (I want feedback on this before merging) and add a `build` script Cory, can you follow @cAZLe85daCHL1WFNpa/6xnp7KJn/7hg1iL2y3qQaBbY=.ed25519 ? This is my laptop's TF feed. Manyverse is acting up on my phone so I can't use my main feed right now.

tasiaiso commented

2024-02-19 15:01:30 -05:00

Also, should we use Tilde Friends' issues tracker (does it even work yet ?) or Gitea's ?

cory commented

2024-02-19 15:53:20 -05:00

You beat me to it. I was planning to make bug #1 be that we're not using Tilde Friends for this. Let's use gitea for now.

cory commented

2024-02-19 21:16:24 -05:00

I followed that account but don't have any data for it.
The issue tracker works in the most basic sense, but what's here is far more robust, so let's use it for now. Also I made #2.
I need visible whitespace, so let's introduce an editor option for it. Sticking a button to toggle it in with the editor's buttons and storing it in localStorage seems like a fine first pass.
On the matter of JSDoc annotations:
- My aim is to move most of the code in core/ to C, but it is a very gradual process / not the highest priority so it takes a back seat.
- I don't understand what the intended workflow is to validate JSDoc here and don't want to contribute to it rotting by not doing the right thing.
- I do want everything documented and intend to extract documentation comments for various purposes.
- I'll help document stuff.
- So all that said, if it makes you happy or provides some value to have JSDoc comments in core, I'm game to bring them in and see what happens. But it may just be temporary.
- C needs comments too, sigh.

* I followed that account but don't have any data for it. * The issue tracker works in the most basic sense, but what's here is far more robust, so let's use it for now. Also I made #2. * I need visible whitespace, so let's introduce an editor option for it. Sticking a button to toggle it in with the editor's buttons and storing it in localStorage seems like a fine first pass. * On the matter of JSDoc annotations: * My aim is to move most of the code in `core/` to C, but it is a very gradual process / not the highest priority so it takes a back seat. * I don't understand what the intended workflow is to validate JSDoc here and don't want to contribute to it rotting by not doing the right thing. * I *do* want everything documented and intend to extract documentation comments for various purposes. * I'll help document stuff. * So all that said, if it makes you happy or provides some value to have JSDoc comments in core, I'm game to bring them in and see what happens. But it may just be temporary. * C needs comments too, sigh.

tasiaiso commented

2024-02-20 12:47:13 -05:00

You beat me to it. I was planning to make bug #1 be that we're not using Tilde Friends for this. Let's use gitea for now.

Ah shame. If that bothers you that much you can work to make #100 (evil smirk) :)

My aim is to move most of the code in core/ to C, but it is a very gradual process / not the highest priority so it takes a back seat.

Would the work of documenting the core folder useful then ? If we don't do a lot of changes when converting the code to C, we could just copy-paste it over.

I need visible whitespace, so let's introduce an editor option for it. Sticking a button to toggle it in with the editor's buttons and storing it in localStorage seems like a fine first pass.

Sure.

> You beat me to it. I was planning to make bug #1 be that we're not using Tilde Friends for this. Let's use gitea for now. Ah shame. If that bothers you that much you can work to make #100 (evil smirk) :) > My aim is to move most of the code in core/ to C, but it is a very gradual process / not the highest priority so it takes a back seat. Would the work of documenting the core folder useful then ? If we don't do a lot of changes when converting the code to C, we could just copy-paste it over. > I need visible whitespace, so let's introduce an editor option for it. Sticking a button to toggle it in with the editor's buttons and storing it in localStorage seems like a fine first pass. Sure.

tasiaiso added 1 commit 2024-02-20 12:50:05 -05:00

chore: revert changes to codemirror's config 12c7515ee8

tasiaiso referenced this pull request

2024-02-20 13:41:22 -05:00

Don't keep OpenSSL binaries in source control. Do make it easy to build them. #11

cory commented

2024-02-20 18:54:31 -05:00

Would the work of documenting the core folder useful then ? If we don't do a lot of changes when converting the code to C, we could just copy-paste it over.

Let's say we document all the JS and the C, and if things move or get deleted, that's fine. 👍

> Would the work of documenting the core folder useful then ? If we don't do a lot of changes when converting the code to C, we could just copy-paste it over. Let's say we document all the JS and the C, and if things move or get deleted, that's fine. 👍

cory merged commit 1db8eee9f7 into main

2024-02-21 18:51:02 -05:00

cory referenced this issue from a commit

2024-02-21 18:51:02 -05:00

Merge pull request 'Documentation, build improvements' (#1) from tasiaiso/tildefriends:dev_tasia into main

Sign in to join this conversation.

No reviewers

No Label

No Milestone

No Assignees

2 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: cory/tildefriends#1