-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
docs(schema): add deprecation policy #261
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great 👍
Putting it in the schema seems fine but can we also add it to developer docs? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Also add to developer docs
I'd prefer not. If the deprecation policy is an intrinsic part of schema file, then it is exchanged with the schema file and it travels with the schema file, wherever it goes. Having an alternate representation of the deprecation policy in the |
Sure I mean maybe we just make a note in the developer docs that the deprecation policy is defined by the schema doc. My point is most people look to documentation on Github. It wouldn't be intuitive to me that the deprecation policy is defined in the Schema itself. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🌭
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
looks great.
|
||
## Deprecation Policy | ||
|
||
Details of the deprecation policy are included in the BuildingSync XML schema file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
No description provided.