Skip to content

📝 [#521] Update docs for setup-config#527

Merged
annashamray merged 8 commits intomasterfrom
feature/521-setup-config-docs
Feb 26, 2025
Merged

📝 [#521] Update docs for setup-config#527
annashamray merged 8 commits intomasterfrom
feature/521-setup-config-docs

Conversation

@stevenbal
Copy link
Collaborator

Fixes #521

Changes

  • Update docs for setup-config

@stevenbal stevenbal force-pushed the feature/521-setup-config-docs branch 2 times, most recently from 1d26001 to 9117045 Compare February 17, 2025 13:40
----------------------

Create or update the (single) YAML configuration file with your settings:
.. FIXME these can currently only be included manually, because these docs are built in
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Not sure if there is a better way to do this, unless we want to give Objecttypes its own RTD page

Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it's good for now
Not sure if we want a separate RTD and separate issue tracker for Objecttypes

Copy link
Collaborator

@annashamray annashamray left a comment

Choose a reason for hiding this comment

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

Nice help texts and descriptions!

----------------------

Create or update the (single) YAML configuration file with your settings:
.. FIXME these can currently only be included manually, because these docs are built in
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think it's good for now
Not sure if we want a separate RTD and separate issue tracker for Objecttypes

@annashamray annashamray removed this from the Objects API release 3.0.1 milestone Feb 26, 2025
@annashamray annashamray force-pushed the feature/521-setup-config-docs branch from 9117045 to 395ffaf Compare February 26, 2025 17:29
@annashamray annashamray merged commit b210736 into master Feb 26, 2025
15 checks passed
@annashamray annashamray deleted the feature/521-setup-config-docs branch February 26, 2025 17: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.

Rewrite setup_configuration documentation with YAML example directive

2 participants