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

proposed: Build a custom blog #184

Open
wion opened this issue Dec 9, 2020 · 1 comment
Open

proposed: Build a custom blog #184

wion opened this issue Dec 9, 2020 · 1 comment
Labels
NEEDS DISCUSSION Use when a proposal is not declined but needs revisions as proposed

Comments

@wion
Copy link
Member

wion commented Dec 9, 2020

URLs

Back: https://docs.textpattern.com/build/custom-blog
Front: https://github.com/textpattern/textpattern.github.io/blob/master/build/custom-blog

Explanation of new page

A doc for learning to build a custom blog by unpacking and understanding the default Textpattern theme, addressing other ‘how to’ type questions people often have, and provide opportunities to segue into using themes and link to that documentation.

List of resources to support draft

(to add as a bulleted list)

To-dos

(to add as a checkbox list)

@wion
Copy link
Member Author

wion commented Dec 10, 2020

While the title initially proposed is short and clear to the topic, putting verbs (e.g. build) or verb participles (e.g. building, or other -ing words) at front of titles always annoys me, as it's not front-loading subject terms, thus making it harder to scan title lists, a usability problem in doc index pages.

It's a challenge to avoid this however, when trying to be succinct (also good for usability). It requires syntactical tricks like I've done with the themes doc title, 'Themes: Creating, using, and sharing'. That may not be appropriate for print mediums, but effective for digital machinery.

So I'm wondering if that pattern might be adopted in docs more, including this one. For example, 'Blogs: Build one as desired'. Adding that with some other ideas:

  • Blogs: Build one as desired
  • Blog site design
  • Blog development

Thoughts welcome.

@wion wion added the NEEDS DISCUSSION Use when a proposal is not declined but needs revisions as proposed label Dec 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
NEEDS DISCUSSION Use when a proposal is not declined but needs revisions as proposed
Projects
None yet
Development

No branches or pull requests

1 participant