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.

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

[docs] Annotate split-domain setup #2372

Merged
merged 1 commit into from
Nov 21, 2023
Merged

[docs] Annotate split-domain setup #2372

merged 1 commit into from
Nov 21, 2023

Conversation

daenney
Copy link
Member

@daenney daenney commented Nov 20, 2023

Description

Small docs improvement that annotate each line with which config option the value needs to match.

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

This adds account-domain and host comments next to each config line to
hopefully make it easier for folks to understand what goes where.
@daenney
Copy link
Member Author

daenney commented Nov 20, 2023

This is what it looks like: https://gotosocial--2372.org.readthedocs.build/en/2372/advanced/host-account-domain/

I need to figure out if there's a better way to annotate code in mkdocs. But for now it'll have to do.

@tsmethurst tsmethurst merged commit 1f96237 into main Nov 21, 2023
3 checks passed
@tsmethurst tsmethurst deleted the docs-annotate-split branch November 21, 2023 10:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants