GithubHelp home page GithubHelp logo

Comments (2)

seancolsen avatar seancolsen commented on June 20, 2024

I like this! To build on your plan, I'll offer some additional suggestions.

  • Change the page title "Email" to "Small emails" to make it more specific
  • Change the page title "Overview" to "Email". This way the reader will see "Email", click to expand, and see "Email" again right below it. Yes, in a way, that's kind of weird and redundant. But overall, I think it's actually a good way to organize content, especially because it allows us to use an index.md file for the page which simplifies the URL. Here's an example of this strategy in action: https://docs.civicrm.org/sysadmin/en/latest/upgrade/ Further, MkDocs has a bit of a limitation in that menu entries must be the same as page titles. Thus, to make the pages google-friendly, we kind of need to use more descriptive menu entries. For example, right now we have a lot of pages titled "What You Need To Know". These pages are harder for people to find on Google, and also harder for people to distinguish between if they have multiple tabs open in their browser.

Side note:

  • I agree that the word "part" is awkward, as you mention. I made this PR to fix it.

from civicrm-user-guide.

github-actions avatar github-actions commented on June 20, 2024

This issue has had no activity in 60 days and has been marked as stale, it will be closed in 10 days.

from civicrm-user-guide.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.