Open
      
        Bug 1915274
      
      
        Opened 1 year ago
          Updated 1 year ago
      
        
    
  
Clean up documentation warnings in NSS
Categories
(NSS :: Documentation, task)
        NSS
          
        
        
      
        
    
        Documentation
          
        
        
      
        
    Tracking
(Not tracked)
        NEW
        
        
    
  
People
(Reporter: standard8, Unassigned)
References
(Blocks 1 open bug)
Details
Attachments
(1 file)
| 14.14 KB,
          text/plain         | Details | 
There are currently around 84 warnings related to NSS documentation when automation is run on mozilla-central. I'm attaching a file with the current set of warnings.
These generally fall into the following categories:
- Simple fixes
- Duplicate labels
- we can probably ignore these for now.
 
- Files not included in the toc
- in particular getting_started.rst and more.rst
 
- Undefined labels
- Most of these appear to be references to the legacy documentation which isn't built due to the amount of warnings, as referenced in bug 1866832
 
I'm wondering if we could clean up the index file to remove/comment-out the undefined labels (which aren't linking anywhere currently)?
Could we also determine what to do with the getting started/more pages that aren't linked to currently?
If we can answer those, or find a solution for the time being, then I think we could probably get most of these warnings tidied up fairly easily.
          You need to log in
          before you can comment on or make changes to this bug.
        
Description
•