Comments (6)
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?
from docs.
Ah, I needed to figure out what I intended here but I remember again:
- only relates to (all) static
.mdx
files in folderrepo/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 likeDetailed 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.
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.
@fflaten can this one be closed now? The canonical did its job as well btw, good job!
from docs.
Yes, but it doesn't look like the descriptions have been indexed yet on Google.
from docs.
Great, I will close. As far as Google is concerned, I am getting used to wait for weeks 🤦♀️
from docs.
Related Issues (20)
- Add usage page about filters HOT 1
- Add usage page for invoking Pester HOT 2
- Cannot execute code in Describe before the ITs HOT 3
- Giscus comments HOT 5
- Multiple sciprt or manifest modules name 'X' are loaded error on Discovery HOT 4
- Update and review additional resources for compatibility HOT 1
- Update Test Results docs with NUnit3 support
- Examples could be slightly more verbose and real-world HOT 2
- Cleanup loader dependencies? HOT 1
- Migrate to tanstack/react-table HOT 1
- Upgrade package manager? HOT 2
- Upgrade Node v18 (v16 EOL) HOT 2
- Search index missing New-PesterConfiguration codeblock HOT 8
- Syntax errors in Quick-Start Creating a Pester Test HOT 1
- Missing docs for FileContentMatchMultilineExactly should assertion HOT 2
- Installation page seems dated: doesn't cover beyond win2k16, win10, ps5 HOT 5
- Please add v6 (alpha)
- Update CodeCoverage usage-docs
- Adding all Pester related PSConfEU videos HOT 2
- Update file placement and discovery about hidden files/folders behavior HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from docs.