Add FAQ to version control #1799
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ekzyis
added
documentation
Draft
huumn
requested changes
Jan 8, 2025
There was a problem hiding this comment.
I'm generally in support of this - mostly for version tracking.
My main complaint is that markdown is a ambiguous toplevel directory for us to have.
I kind of likedocfood, but that's confusing in a "wtf" way.
Given this is run as a script remotely, it might make sense to put the script in scripts?
I don't know about all the other stuff, but it shouldn't be named markdown.
I agree, I moved it into
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
I think it's a good idea to add our special items to version control so we have a history of changes and a familiar process to discuss, review and apply changes to them. It's (unfortunately) also easier to edit these markdown documents in a proper text editor instead of the SN editor.
I've added a script that can "deploy" the markdown content via an API key from an account included in
SN_USER_IDS.For now, I only did this to the FAQ in case @huumn does not like this idea.
I tested this locally by adding my test user to
SN_USER_IDSand using an API key from that test account.