Giter Club home page Giter Club logo

Comments (9)

deejaygraham avatar deejaygraham commented on August 27, 2024 1

Yes, think so.

from docs.

deejaygraham avatar deejaygraham commented on August 27, 2024

I can pick this one up.

from docs.

bravo-kernel avatar bravo-kernel commented on August 27, 2024

Cool, that would be awesome. Please keep a couple of things in mind.

  • all links in the source should probably be a direct link to the corresponding pester.dev website (e.g. replacce It with the full link (or the website links will not work)
  • we should probably make this a co-op. You make the changes in Pester repository, I use your Pester PR branch to generate a PR in this repository with the auto-generated command reference here.

Does that sound ok to you?

from docs.

deejaygraham avatar deejaygraham commented on August 27, 2024

Broke the blocks of links into separate chunks yesterday but before I go any further, I want to check about the actual link text. I get that some are using the old url and the wrong page name that can be fixed. I am more wondering about whether each command should have an online link to the docs . For example I think this is correct (with comments afterwards):

Context

...

.LINK
https://pester.dev/docs/commands/Context (change url)

.LINK
Describe (related command, leave as is ?)

.LINK
about_Should (related command, leave as is ?)

from docs.

bravo-kernel avatar bravo-kernel commented on August 27, 2024

I guess @nohwnd should check your Pester PR, see what he thinks.

from docs.

bravo-kernel avatar bravo-kernel commented on August 27, 2024

If you are for example suggesting we should leave ‘about_Should’ exactly that text then I wonder what happens inside Docusaurus. Does it produce a valid URL by itself? If not, changing it to full url should be the best solution IMO but that’s personal. I prefer to see full links when running Get-Help but... perhaps other systems/tools expect this format.

Apologies for the long text, was a bit of a long day

from docs.

deejaygraham avatar deejaygraham commented on August 27, 2024

No, no problem. I'll make a PR as it is with fixed links etc. but leave the rest alone for now and we can see what opinions come out.

from docs.

bravo-kernel avatar bravo-kernel commented on August 27, 2024

Aha, I think I understand now. I will generate a PR here using your Pester PR somewhere this Friday or weekend. That way we can reason about/view the outcome. Thanks again!

from docs.

deejaygraham avatar deejaygraham commented on August 27, 2024

pester/Pester#1432

Added a note about what the correct format is for all .LINK entries.

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.