Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve config creation/syncing guides. #67

Closed
wants to merge 33 commits into from
Closed

Improve config creation/syncing guides. #67

wants to merge 33 commits into from

Conversation

Owen3H
Copy link
Contributor

@Owen3H Owen3H commented Jan 3, 2024 •
edited
Loading

  • Replaces the stinky BinaryFormatter with DataContractSerializer - a more secure and slightly faster alternative that doesn't require a NuGet package or changing NET version.👍🏼
  • Config entries are no longer static and now use primitive types instead of ConfigEntry since it can't be serialized.
  • Fixed the large config file problem by utilizing a new SendMessage method that checks whether to fragment.
  • Other general QoL (headings, formatting and examples)

Fixes #65

@legoandmars
Copy link
Contributor

Most of this looks good, I'm not sure I like having config values read from .Value on start though

This will prevent runtime editing of config values with future plugins and things like ConfigurationManager

@legoandmars
Copy link
Contributor

When I have some time i'll see if I can figure out a non-insane way to retain using ConfigEntry with syncing

Xilophor
Xilophor reviewed Jan 23, 2024
View reviewed changes
Copy link
Contributor

@Xilophor Xilophor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm; only a few comments on some formatting/logging stuff.

Xilophor
Xilophor reviewed Jan 23, 2024
View reviewed changes
docs/dev/intermediate/custom-config-syncing.md Outdated Show resolved Hide resolved
docs/dev/intermediate/custom-config-syncing.md Outdated Show resolved Hide resolved
docs/dev/intermediate/custom-config-syncing.md Outdated Show resolved Hide resolved
@Owen3H
Copy link
Contributor Author

Owen3H commented Feb 3, 2024 •
edited
Loading

With the release of CSync, I have added a new section under Programming APIs and updated the Custom Config Syncing page accordingly.

@Owen3H
Copy link
Contributor Author

Owen3H commented Feb 5, 2024

Should also close #56

Xilophor
Xilophor requested changes Feb 10, 2024
View reviewed changes
docs/.vitepress/config.mts Outdated Show resolved Hide resolved
docs/dev/apis/csync.md Outdated Show resolved Hide resolved
docs/dev/apis/csync/publishing.md Outdated Show resolved Hide resolved
docs/dev/apis/overview.md Outdated Show resolved Hide resolved
docs/dev/apis/overview.md Outdated Show resolved Hide resolved
docs/dev/intermediate/custom-config-syncing.md
@@ -6,281 +6,32 @@ description: An intermediate overview of how to sync custom configs for your Let

# Custom Config Syncing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please do not remove the contents of this file. We want to make sure that a way w/o APIs is provided for those pursuing this. You can, however, leave the section about the config syncing APIs and move that above the rest of the article, with text saying that an easier method is available.

docs/dev/intermediate/custom-configs.md Outdated Show resolved Hide resolved
@Owen3H Owen3H closed this Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@1A3Dev 1A3Dev 1A3Dev left review comments

@Xilophor Xilophor Awaiting requested review from Xilophor

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix config creation/syncing pages
4 participants
@Owen3H @legoandmars @1A3Dev @Xilophor