Repository navigation
List what works today under Features and Capabilities - #78
Merged
Merged
Conversation
…list only what works today
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The problem
The README's Status table spent a column on a label that was almost always the same, Available today, and listed two capabilities that do not work yet next to the ones that do. A reader skimming it had to read the third column to tell them apart.
The approach
The section is now called Features and Capabilities. It lists only what works when you run the repository, so the Status column goes. The two rows that are still being built (watching mail, calendar and Slack as they arrive, and the sensitive-information check on outgoing messages) are removed from the table. The section's intro, the link in the header row, and the two sentences that pointed at the old table now say it lists what works today.
What is not covered
Verification
README only. The table renders with two columns, and every link to the old #status anchor now points at #features-and-capabilities.