August Dreamwidth Documentation Suggestions Thread

[ivorygates]

This is the August thread for suggesting new FAQs, suggesting changes to existing FAQs, posting errors in existing FAQs, and for changes to/additions to/errors in site copy which is not FAQs.

Comments

[msilverstar]

I'd like to see a separate page that describes the new <user> tag, with lots of synonyms and things people might search on, like "lj-user" and "new syntax" and "tag" and so on.

And using Sphinx to index and search the FAQs would be great, now it's a string match and so if you search for two words, but in the wrong order, they just don't come up. Would be a good way to slowly ramp up Sphinx and make sure it scales.

[ivorygates]

I believe the reason for not putting in a bunch of synonyms and hypothetical search terms is because while they're invisible to conventionally-sighted people, they interfere with the use of a screen reader. I'll check on that to make certain I'm correct.

And using Sphinx to index and search the FAQs would be great, now it's a string match and so if you search for two words, but in the wrong order, they just don't come up. Would be a good way to slowly ramp up Sphinx and make sure it scales.

Sphinx is this? http://en.wikipedia.org/wiki/Sphinx_%28search_engine%29

That's a coding/programming decision, not a docs problem, but I'll make sure they're aware of it.

[zvi]

If Sphinx (or the current search function) will read it, you could put synonyms in <!-- comments -->. Screenreaders won't read those. (Alternately, if they're formatted with display: none; speak: none; they are invisible to all browsers that understand CSS, including screen readers.)