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

Add initial deprecation notices #157

Merged
merged 1 commit into from
Mar 22, 2019
Merged

Add initial deprecation notices #157

merged 1 commit into from
Mar 22, 2019

Conversation

yusefnapora
Copy link
Contributor

This adds some warning text to a few sections of the main specs document to signal that we're aware of its shortcomings and are working on improving the spec. The odd formatting is me abusing github markdown's table syntax to draw some attention to the text.

So far I've just added a pretty generic notice to the intro and the sections that seem (to me) to be the most problematic: architecture, interfaces and properties.

There are other sections that need work as well, but those three need the most attention in the short term, IMO.

Questions:

  • do we agree that these sections should be considered deprecated?
  • what other parts of the spec should have "warning notices"?
  • right now all the notices link to Improve outdated / misleading specs #156 - perhaps it would be better to make one issue per document to track ideas for improving each individually?
  • what's the best way to prioritize improving the docs?

Another larger question is whether we should go big and focus on #110 vs rehabilitating the existing specs.

@yusefnapora yusefnapora requested review from vyzo, bigs, a user and raulk March 21, 2019 14:12
@ghost ghost assigned yusefnapora Mar 21, 2019
@ghost ghost added the in progress label Mar 21, 2019
@yusefnapora yusefnapora merged commit 63c77f8 into master Mar 22, 2019
@yusefnapora yusefnapora deleted the deprecation-notices branch March 22, 2019 13:50
@ghost ghost removed the in progress label Mar 22, 2019
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.

2 participants