docs(batch): add section on how to trace batch processing

[dreamorosi]

Description of your changes

This PR introduces a new section to the Batch Processing docs that details how to create dedicated subsegments for each record processed in a batch. I decided to include a dedicated section since the operation might not immediately be straightforward due to the presence of an iteration.

// ... imports omitted for brevity see docs/snippets/batch/advancedTracingRecordHandler.ts for full snippet

const processor = new BatchProcessor(EventType.SQS);
const tracer = new Tracer({ serviceName: 'serverlessAirline' });

const recordHandler = (record: SQSRecord): void => {
  const subsegment = tracer.getSegment()?.addNewSubsegment('### recordHandler'); 
  subsegment?.addAnnotation('messageId', record.messageId); 

  const payload = record.body;
  if (payload) {
    try {
      const item = JSON.parse(payload);
      // do something with the item
      subsegment?.addMetadata('item', item);
    } catch (error) {
      subsegment?.addError(error);
      throw error;
    }
  }

  subsegment?.close(); 
};

export const handler = middy(
  async (event: SQSEvent, context: Context): Promise<SQSBatchResponse> => {
    return processPartialResponse(event, recordHandler, processor, {
      context,
    });
  }
).use(captureLambdaHandler(tracer));

Additionally, the PR also addresses a two housekeeping items related to documentation:

• Fix warnings related to relative links during docs build (example)
• Restore original menu/nav positioning to align with Python

Related issues, RFCs

Issue number: #471

Checklist

• My changes meet the tenets criteria
• I have performed a self-review of my own code
• I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my change is effective and works
• The PR title follows the conventional commit semantics

Breaking change checklist

Is it a breaking change?: NO

• I have documented the migration process
• I have added, implemented necessary warnings (if it can live side by side)

---

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication