Giter Club home page Giter Club logo

Comments (6)

fflaten avatar fflaten commented on July 24, 2024

Do you know if keywords will help DocSearch? Because they're not used by search engines anymore AFAIK, so if not we could ignore that.

Description meta-tags are created using the first lines of content (no headings) when not specified explicitly. In many cases those are fine. Should we focus on adding a quick 1-2 line intro per file when missing maybe? Thoughts?
image

from docs.

bravo-kernel avatar bravo-kernel commented on July 24, 2024

Ah, I needed to figure out what I intended here but I remember again:

  • only relates to (all) static .mdx files in folder repo/docs
  • your suggestion for description sounds great: "first lines unless that doesn't work". E.g. for the Unit Testing within Modules example above I think we would need to make something up like Detailed instructions on the two Pester methods available to perform unit tests and mocks within Powershell Modules.
  • IMO nobody really knows if keywords are not used for SEO anymore but why take the risk plus we might exclude ourselves from other tools that use keywords if we choose do not add them

Hope this clarifies things 💃

from docs.

bravo-kernel avatar bravo-kernel commented on July 24, 2024

Of course not needed for the auto-generated files in repo/docs/commands. I see I already auto-generate those fields.

https://raw.githubusercontent.com/pester/docs/master/docs/commands/Add-ShouldOperator.mdx

from docs.

bravo-kernel avatar bravo-kernel commented on July 24, 2024

@fflaten can this one be closed now? The canonical did its job as well btw, good job!

from docs.

fflaten avatar fflaten commented on July 24, 2024

Yes, but it doesn't look like the descriptions have been indexed yet on Google.

from docs.

bravo-kernel avatar bravo-kernel commented on July 24, 2024

Great, I will close. As far as Google is concerned, I am getting used to wait for weeks 🤦‍♀️

from docs.

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.