[JENKINS-49171] Jenkins Pipeline Documentation Readability

The readability of jenkins pipeline steps documentation could be significantly improved for new Jenkins pipeline users. In particular, adding visible containers and indenting could help indicate the structure of each documentation page.

Here's an outside example of nicely designed, readable documentation:

https://developer.apple.com/documentation/quartzcore/caanimation

Example of poor readability: in particular it is difficult to see which parameter the "Type: boolean" is applying to:

https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#code-stash-code-stash-some-files-to-be-used-later-in-the-build

 

Example of lack of indenting:

---
Originally reported by ericnondahl, imported from: Jenkins Pipeline Documentation Readability

• status: Open
  
• priority: Major
  
• component(s): pipeline
  
• resolution: Unresolved
  
• votes: 1
  
• watchers: 3
  
• imported: 2025-12-08
  

Raw content of original issue

The readability of jenkins pipeline steps documentation could be significantly improved for new Jenkins pipeline users. In particular, adding visible containers and indenting could help indicate the structure of each documentation page.


Here's an outside example of nicely designed, readable documentation:


https://developer.apple.com/documentation/quartzcore/caanimation


Example of poor readability: in particular it is difficult to see which parameter the "Type: boolean" is applying to:


https://jenkins.io/doc/pipeline/steps/workflow-basic-steps/#code-stash-code-stash-some-files-to-be-used-later-in-the-build




 


Example of lack of indenting:

2 attachments

- [image-2018-01-25-11-34-08-313.png](https://issues.jenkins.io/secure/attachment/41248/image-2018-01-25-11-34-08-313.png)
> 
- [image-2018-01-25-11-36-58-043.png](https://issues.jenkins.io/secure/attachment/41247/image-2018-01-25-11-36-58-043.png)
>